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

This returns planning form details here the specified field contains the specified search text or equals the search text if exact = true.

Request Information

Parameters

Name	Description	Additional 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 planning form details

Response body formats

text/html

Sample:

<div class="input-group">
    <label class="sr-only" for="filter">Filter</label>
    <span class="input-group-addon">Filter</span>
    <input id="filter" type="text" class="form-control" placeholder="Filter..." />
</div>
<table class="hdc-table table default" data-filter="#filter">
    <thead>
        <tr>
            <th data-toggle="true" class="footable-first-column">
                Checklist and Guidance Notes Description
            </th>
            
            <th>
                Checklist and Guidance Notes
            </th>
        </tr>
    </thead>
    <tbody>
            <tr>
                <td>
                    sample string 2
                </td>
                
                <td class="hyperlink">
                    <a href="sample string 6">sample string 5</a>
                </td>
            </tr>
            <tr>
                <td>
                    sample string 2
                </td>
                
                <td class="hyperlink">
                    <a href="sample string 6">sample string 5</a>
                </td>
            </tr>
            <tr>
                <td>
                    sample string 2
                </td>
                
                <td class="hyperlink">
                    <a href="sample string 6">sample string 5</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,
    "form_Description": "sample string 2",
    "download_Form1": "sample string 3",
    "download_Form2": "sample string 4",
    "checklist_and_Guidance_Notes1": "sample string 5",
    "checklist_and_Guidance_Notes2": "sample string 6"
  },
  {
    "id": 1,
    "form_Description": "sample string 2",
    "download_Form1": "sample string 3",
    "download_Form2": "sample string 4",
    "checklist_and_Guidance_Notes1": "sample string 5",
    "checklist_and_Guidance_Notes2": "sample string 6"
  },
  {
    "id": 1,
    "form_Description": "sample string 2",
    "download_Form1": "sample string 3",
    "download_Form2": "sample string 4",
    "checklist_and_Guidance_Notes1": "sample string 5",
    "checklist_and_Guidance_Notes2": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlanning_Form xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDCAPIModel.Models">
  <Planning_Form>
    <Checklist_and_Guidance_Notes1>sample string 5</Checklist_and_Guidance_Notes1>
    <Checklist_and_Guidance_Notes2>sample string 6</Checklist_and_Guidance_Notes2>
    <Download_Form1>sample string 3</Download_Form1>
    <Download_Form2>sample string 4</Download_Form2>
    <Form_Description>sample string 2</Form_Description>
    <ID>1</ID>
  </Planning_Form>
  <Planning_Form>
    <Checklist_and_Guidance_Notes1>sample string 5</Checklist_and_Guidance_Notes1>
    <Checklist_and_Guidance_Notes2>sample string 6</Checklist_and_Guidance_Notes2>
    <Download_Form1>sample string 3</Download_Form1>
    <Download_Form2>sample string 4</Download_Form2>
    <Form_Description>sample string 2</Form_Description>
    <ID>1</ID>
  </Planning_Form>
  <Planning_Form>
    <Checklist_and_Guidance_Notes1>sample string 5</Checklist_and_Guidance_Notes1>
    <Checklist_and_Guidance_Notes2>sample string 6</Checklist_and_Guidance_Notes2>
    <Download_Form1>sample string 3</Download_Form1>
    <Download_Form2>sample string 4</Download_Form2>
    <Form_Description>sample string 2</Form_Description>
    <ID>1</ID>
  </Planning_Form>
</ArrayOfPlanning_Form>

text/javascript

Sample:

([{"id":1,"form_Description":"sample string 2","download_Form1":"sample string 3","download_Form2":"sample string 4","checklist_and_Guidance_Notes1":"sample string 5","checklist_and_Guidance_Notes2":"sample string 6"},{"id":1,"form_Description":"sample string 2","download_Form1":"sample string 3","download_Form2":"sample string 4","checklist_and_Guidance_Notes1":"sample string 5","checklist_and_Guidance_Notes2":"sample string 6"},{"id":1,"form_Description":"sample string 2","download_Form1":"sample string 3","download_Form2":"sample string 4","checklist_and_Guidance_Notes1":"sample string 5","checklist_and_Guidance_Notes2":"sample string 6"}]);