items[] |
list |
The results of the completed search.
|
Optional.
|
items[].address |
object |
The service address of the officer.
|
|
items[].address.address_line_1 |
string |
The first line of the address.
|
Optional.
|
items[].address.address_line_2 |
string |
The second line of the address.
|
Optional.
|
items[].address.care_of |
string |
The care of name.
|
Optional.
|
items[].address.country |
string |
The country. For example, UK.
|
Optional.
|
items[].address.locality |
string |
The locality. For example London.
|
Optional.
|
items[].address.po_box |
string |
The post-office box number.
|
Optional.
|
items[].address.postal_code |
string |
The postal code. For example CF14 3UZ.
|
Optional.
|
items[].address.premises |
string |
The property name or number.
|
Optional.
|
items[].address.region |
string |
The region. For example Surrey.
|
Optional.
|
items[].address_snippet |
string |
A single line address. This will be the address that matched within the indexed document, or the primary address otherwise (as returned by the address member).
|
|
items[].appointment_count |
integer |
The total number of appointments the officer has.
|
|
items[].date_of_birth |
object |
The officer date of birth details.
|
Optional.
|
items[].date_of_birth.month |
integer |
The month the officer was born in.
|
|
items[].date_of_birth.year |
integer |
The year the officer was born in.
|
|
items[].description |
string |
The result description.
|
|
items[].description_identifiers |
Array |
An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations.
|
Optional.
|
items[].kind |
string |
Describes the type of result returned.
Possible values are:
|
|
items[].links |
object |
Links to other resources associated with this search item.
|
Optional.
|
items[].links.self |
string |
The URL of the resource being returned by the search item.
|
|
items[].matches[] |
list |
A list of members and arrays of character offset, defining substrings that matched the search terms.
|
Optional.
|
items[].matches[].address_snippet |
Array |
An array of character offset into the address_snippet string. These always occur in pairs, and define the start and end of substrings in the member address_snippet that matched the search terms.
|
Optional.
|
items[].matches[].snippet |
Array |
An array of character offset into the snippet string. These always occur in pairs, and define the start and end of substrings in the member snippet that matched the search terms. The first character of the string is index 1.
|
Optional.
|
items[].matches[].title |
Array |
An array of character offset into the title string. These always occur in pairs, and define the start and end of substrings in the member title that matched the search terms. The first character of the string is index 1.
|
Optional.
|
items[].snippet |
string |
Summary information for the result, showing additional details that have matched. In the case of company officers, this would be other appointment names for the officer .
|
Optional.
|
items[].title |
string |
The title of the search result.
|
|
items_per_page |
integer |
The number of search items returned per page.
|
Optional.
|
kind |
string |
The type of response returned.
Possible values are:
|
|
start_index |
integer |
The index into the entire result set that this result page starts.
|
Optional.
|
total_results |
integer |
The number of further search results available for the current search.
|
Optional.
|