GET api/ConsultationsCalendar?field={field}&search={search}&exact={exact}

This returns data where the specified field contains the specified search text or equals the search text if exact = true.

Request Information

Parameters

NameDescriptionAdditional information
field
The Name of the field to search against

Define this parameter in the request URI.

search
The text to search for

Define this parameter in the request URI.

exact
Set to true if match must be exact

Define this parameter in the request URI.

Response Information

filtered list of consultations

Response body formats

text/html

Sample:

<table class="hdc-table table default" data-filter="#filter">
    <thead>
        <tr>
            <th data-toggle="true" class="footable-first-column">
                Consultation
            </th>
            <th data-hide="phone">
                Details
            </th>
            <th data-hide="phone">
                Method
            </th>
            <th id="decision" data-hide="phone">
                Decisions and Outcomes
            </th>
            <th id="SurveyLink">
                Survey
            </th>
            <th id="ReportLink">
                Report
            </th>
             
        </tr>
    </thead>
    <tbody>
            <tr>
                <td>
                    sample string 7
                </td>
                <td>
                    sample string 9
                </td>
                <td>
                    sample string 12
                </td>
                <td>
                    sample string 8
                </td>
                <td>
                    <a class="link" href="sample string 10">sample string 14</a>
                </td>
                <td>
                    <a href="sample string 11">sample string 15</a>
                </td>

                
            </tr>
            <tr>
                <td>
                    sample string 7
                </td>
                <td>
                    sample string 9
                </td>
                <td>
                    sample string 12
                </td>
                <td>
                    sample string 8
                </td>
                <td>
                    <a class="link" href="sample string 10">sample string 14</a>
                </td>
                <td>
                    <a href="sample string 11">sample string 15</a>
                </td>

                
            </tr>
            <tr>
                <td>
                    sample string 7
                </td>
                <td>
                    sample string 9
                </td>
                <td>
                    sample string 12
                </td>
                <td>
                    sample string 8
                </td>
                <td>
                    <a class="link" href="sample string 10">sample string 14</a>
                </td>
                <td>
                    <a href="sample string 11">sample string 15</a>
                </td>

                
            </tr>
    </tbody>
    <tfoot class="hide-if-no-paging">
        <tr>
            <td colspan="6">
                <ul class="pagination pagination-centered hide-if-no-paging"></ul>
            </td>
        </tr>
    </tfoot>
</table>

application/json, text/json

Sample:
[
  {
    "id": 1,
    "year": "sample string 2",
    "division": "sample string 3",
    "responsible_Officer": "sample string 4",
    "status": "sample string 5",
    "modified": "2020-02-22T19:30:22.2167853+00:00",
    "approximate_date_when_findings_can_be_shared": "sample string 6",
    "consultation1": "sample string 7",
    "consultation_close_date": "2020-02-22T19:30:22.2167853+00:00",
    "consultation_open_date": "2020-02-22T19:30:22.2167853+00:00",
    "decisions_and_Outcomes": "sample string 8",
    "details": "sample string 9",
    "link_to_consultation": "sample string 10",
    "link_to_Report": "sample string 11",
    "method_of_Consultation": "sample string 12",
    "publish_to_Website": true,
    "response_rate_or_percentage_where_applicable": 1.1,
    "sample_Size": 1.1,
    "who_is_being_consulted": "sample string 13",
    "consultation_Link_Text": "sample string 14",
    "report_Link_Text": "sample string 15"
  },
  {
    "id": 1,
    "year": "sample string 2",
    "division": "sample string 3",
    "responsible_Officer": "sample string 4",
    "status": "sample string 5",
    "modified": "2020-02-22T19:30:22.2167853+00:00",
    "approximate_date_when_findings_can_be_shared": "sample string 6",
    "consultation1": "sample string 7",
    "consultation_close_date": "2020-02-22T19:30:22.2167853+00:00",
    "consultation_open_date": "2020-02-22T19:30:22.2167853+00:00",
    "decisions_and_Outcomes": "sample string 8",
    "details": "sample string 9",
    "link_to_consultation": "sample string 10",
    "link_to_Report": "sample string 11",
    "method_of_Consultation": "sample string 12",
    "publish_to_Website": true,
    "response_rate_or_percentage_where_applicable": 1.1,
    "sample_Size": 1.1,
    "who_is_being_consulted": "sample string 13",
    "consultation_Link_Text": "sample string 14",
    "report_Link_Text": "sample string 15"
  },
  {
    "id": 1,
    "year": "sample string 2",
    "division": "sample string 3",
    "responsible_Officer": "sample string 4",
    "status": "sample string 5",
    "modified": "2020-02-22T19:30:22.2167853+00:00",
    "approximate_date_when_findings_can_be_shared": "sample string 6",
    "consultation1": "sample string 7",
    "consultation_close_date": "2020-02-22T19:30:22.2167853+00:00",
    "consultation_open_date": "2020-02-22T19:30:22.2167853+00:00",
    "decisions_and_Outcomes": "sample string 8",
    "details": "sample string 9",
    "link_to_consultation": "sample string 10",
    "link_to_Report": "sample string 11",
    "method_of_Consultation": "sample string 12",
    "publish_to_Website": true,
    "response_rate_or_percentage_where_applicable": 1.1,
    "sample_Size": 1.1,
    "who_is_being_consulted": "sample string 13",
    "consultation_Link_Text": "sample string 14",
    "report_Link_Text": "sample string 15"
  }
]

application/xml, text/xml

Sample:
<ArrayOfConsultation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDCAPIModel.Models">
  <Consultation>
    <Approximate_date_when_findings_can_be_shared>sample string 6</Approximate_date_when_findings_can_be_shared>
    <Consultation1>sample string 7</Consultation1>
    <Consultation_Link_Text>sample string 14</Consultation_Link_Text>
    <Consultation_close_date>2020-02-22T19:30:22.2167853+00:00</Consultation_close_date>
    <Consultation_open_date>2020-02-22T19:30:22.2167853+00:00</Consultation_open_date>
    <Decisions_and_Outcomes>sample string 8</Decisions_and_Outcomes>
    <Details>sample string 9</Details>
    <Division>sample string 3</Division>
    <ID>1</ID>
    <Link_to_Report>sample string 11</Link_to_Report>
    <Link_to_consultation>sample string 10</Link_to_consultation>
    <Method_of_Consultation>sample string 12</Method_of_Consultation>
    <Modified>2020-02-22T19:30:22.2167853+00:00</Modified>
    <Publish_to_Website>true</Publish_to_Website>
    <Report_Link_Text>sample string 15</Report_Link_Text>
    <Response_rate_or_percentage_where_applicable>1.1</Response_rate_or_percentage_where_applicable>
    <Responsible_Officer>sample string 4</Responsible_Officer>
    <Sample_Size>1.1</Sample_Size>
    <Status>sample string 5</Status>
    <Who_is_being_consulted>sample string 13</Who_is_being_consulted>
    <Year>sample string 2</Year>
  </Consultation>
  <Consultation>
    <Approximate_date_when_findings_can_be_shared>sample string 6</Approximate_date_when_findings_can_be_shared>
    <Consultation1>sample string 7</Consultation1>
    <Consultation_Link_Text>sample string 14</Consultation_Link_Text>
    <Consultation_close_date>2020-02-22T19:30:22.2167853+00:00</Consultation_close_date>
    <Consultation_open_date>2020-02-22T19:30:22.2167853+00:00</Consultation_open_date>
    <Decisions_and_Outcomes>sample string 8</Decisions_and_Outcomes>
    <Details>sample string 9</Details>
    <Division>sample string 3</Division>
    <ID>1</ID>
    <Link_to_Report>sample string 11</Link_to_Report>
    <Link_to_consultation>sample string 10</Link_to_consultation>
    <Method_of_Consultation>sample string 12</Method_of_Consultation>
    <Modified>2020-02-22T19:30:22.2167853+00:00</Modified>
    <Publish_to_Website>true</Publish_to_Website>
    <Report_Link_Text>sample string 15</Report_Link_Text>
    <Response_rate_or_percentage_where_applicable>1.1</Response_rate_or_percentage_where_applicable>
    <Responsible_Officer>sample string 4</Responsible_Officer>
    <Sample_Size>1.1</Sample_Size>
    <Status>sample string 5</Status>
    <Who_is_being_consulted>sample string 13</Who_is_being_consulted>
    <Year>sample string 2</Year>
  </Consultation>
  <Consultation>
    <Approximate_date_when_findings_can_be_shared>sample string 6</Approximate_date_when_findings_can_be_shared>
    <Consultation1>sample string 7</Consultation1>
    <Consultation_Link_Text>sample string 14</Consultation_Link_Text>
    <Consultation_close_date>2020-02-22T19:30:22.2167853+00:00</Consultation_close_date>
    <Consultation_open_date>2020-02-22T19:30:22.2167853+00:00</Consultation_open_date>
    <Decisions_and_Outcomes>sample string 8</Decisions_and_Outcomes>
    <Details>sample string 9</Details>
    <Division>sample string 3</Division>
    <ID>1</ID>
    <Link_to_Report>sample string 11</Link_to_Report>
    <Link_to_consultation>sample string 10</Link_to_consultation>
    <Method_of_Consultation>sample string 12</Method_of_Consultation>
    <Modified>2020-02-22T19:30:22.2167853+00:00</Modified>
    <Publish_to_Website>true</Publish_to_Website>
    <Report_Link_Text>sample string 15</Report_Link_Text>
    <Response_rate_or_percentage_where_applicable>1.1</Response_rate_or_percentage_where_applicable>
    <Responsible_Officer>sample string 4</Responsible_Officer>
    <Sample_Size>1.1</Sample_Size>
    <Status>sample string 5</Status>
    <Who_is_being_consulted>sample string 13</Who_is_being_consulted>
    <Year>sample string 2</Year>
  </Consultation>
</ArrayOfConsultation>

text/javascript

Sample:
([{"id":1,"year":"sample string 2","division":"sample string 3","responsible_Officer":"sample string 4","status":"sample string 5","modified":"2020-02-22T19:30:22.2167853+00:00","approximate_date_when_findings_can_be_shared":"sample string 6","consultation1":"sample string 7","consultation_close_date":"2020-02-22T19:30:22.2167853+00:00","consultation_open_date":"2020-02-22T19:30:22.2167853+00:00","decisions_and_Outcomes":"sample string 8","details":"sample string 9","link_to_consultation":"sample string 10","link_to_Report":"sample string 11","method_of_Consultation":"sample string 12","publish_to_Website":true,"response_rate_or_percentage_where_applicable":1.1,"sample_Size":1.1,"who_is_being_consulted":"sample string 13","consultation_Link_Text":"sample string 14","report_Link_Text":"sample string 15"},{"id":1,"year":"sample string 2","division":"sample string 3","responsible_Officer":"sample string 4","status":"sample string 5","modified":"2020-02-22T19:30:22.2167853+00:00","approximate_date_when_findings_can_be_shared":"sample string 6","consultation1":"sample string 7","consultation_close_date":"2020-02-22T19:30:22.2167853+00:00","consultation_open_date":"2020-02-22T19:30:22.2167853+00:00","decisions_and_Outcomes":"sample string 8","details":"sample string 9","link_to_consultation":"sample string 10","link_to_Report":"sample string 11","method_of_Consultation":"sample string 12","publish_to_Website":true,"response_rate_or_percentage_where_applicable":1.1,"sample_Size":1.1,"who_is_being_consulted":"sample string 13","consultation_Link_Text":"sample string 14","report_Link_Text":"sample string 15"},{"id":1,"year":"sample string 2","division":"sample string 3","responsible_Officer":"sample string 4","status":"sample string 5","modified":"2020-02-22T19:30:22.2167853+00:00","approximate_date_when_findings_can_be_shared":"sample string 6","consultation1":"sample string 7","consultation_close_date":"2020-02-22T19:30:22.2167853+00:00","consultation_open_date":"2020-02-22T19:30:22.2167853+00:00","decisions_and_Outcomes":"sample string 8","details":"sample string 9","link_to_consultation":"sample string 10","link_to_Report":"sample string 11","method_of_Consultation":"sample string 12","publish_to_Website":true,"response_rate_or_percentage_where_applicable":1.1,"sample_Size":1.1,"who_is_being_consulted":"sample string 13","consultation_Link_Text":"sample string 14","report_Link_Text":"sample string 15"}]);