- get - Search disqualified officers
{
"etag": "string",
"items": [
{
"address": {
"address_line_1": "string",
"address_line_2": "string",
"country": "string",
"locality": "string",
"postal_code": "string",
"premises": "string",
"region": "string"
},
"address_snippet": "string",
"date_of_birth": "date",
"description": "string",
"description_identifiers": [
"string"
],
"kind": "string",
"links": {
"self": "string"
},
"matches": {
"address_snippet": [
"integer"
],
"snippet": [
"integer"
],
"title": [
"integer"
]
},
"snippet": "string",
"title": "string"
}
],
"items_per_page": "integer",
"kind": "string",
"start_index": "integer",
"total_results": "integer"
}
| Name |
Type |
Description |
Additional |
|
etag
|
string |
The ETag of the resource
|
Optional
|
|
items[]
|
array |
The results of the completed search.
|
Optional
|
|
items[].address
|
object |
The address of the disqualified officer as provided by the disqualifying authority.
|
|
|
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.country
|
string |
The country. For example UK.
|
Optional
|
|
items[].address.locality
|
string |
The locality. For example London.
|
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[].date_of_birth
|
date |
The disqualified officer's date of birth.
|
Optional
|
|
items[].description
|
string |
The result description.
|
|
|
items[].description_identifiers[]
|
array of string |
An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations.
Possible values are:
|
Optional
|
|
items[].kind
|
string |
Describes the type of result returned.
Possible values are:
searchresults#disqualified-officer
|
|
|
items[].links
|
object |
The URL of the search result.
|
Optional
|
|
items[].links.self
|
string |
The URL of the resource being returned by the search item.
|
Optional
|
|
items[].matches
|
object |
A list of members and arrays of character offset defining substrings that matched the search terms.
|
Optional
|
|
items[].matches.address_snippet[]
|
array of integer |
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 of integer |
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 of integer |
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.
|
Optional
|
|
items[].title
|
string |
The title of the search result.
|
|
|
items_per_page
|
integer |
The number of search items returned per page.
|
|
|
kind
|
string |
The type of response returned.
Possible values are:
search#disqualified-officers
|
|
|
start_index
|
integer |
The index into the entire result set that this result page starts.
|
|
|
total_results
|
integer |
The number of further search results available for the current search.
|
|