POST api/Halo/Retrieve

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AuthKey	globally unique identifier	None.
Product	string	None.
URN	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AuthKey": "873939ee-becd-4a09-8850-9864035b1b04",
  "Product": "sample string 2",
  "URN": "sample string 3"
}

text/html

Sample:

{"AuthKey":"873939ee-becd-4a09-8850-9864035b1b04","Product":"sample string 2","URN":"sample string 3"}

application/xml, text/xml

Sample:

<RetrieveParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Product>sample string 2</Product>
  <URN>sample string 3</URN>
  <AuthKey>873939ee-becd-4a09-8850-9864035b1b04</AuthKey>
</RetrieveParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HaloProductResult

Name	Type	Additional information
ResultCount	integer	None.
Results	Collection of HaloResultRow	None.
ErrorCount	integer	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCount": 2,
  "Results": [
    {
      "Unique_Reference_Number": "sample string 1",
      "Title": "sample string 2",
      "Forename": "sample string 3",
      "Middlename": "sample string 4",
      "Surname": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "Address3": "sample string 8",
      "Address4": "sample string 9",
      "Address5": "sample string 10",
      "PostCode": "sample string 11",
      "Gender": "sample string 12",
      "Source": "sample string 13",
      "Date_of_Birth": "sample string 14",
      "Date_of_Death": "sample string 15"
    },
    {
      "Unique_Reference_Number": "sample string 1",
      "Title": "sample string 2",
      "Forename": "sample string 3",
      "Middlename": "sample string 4",
      "Surname": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "Address3": "sample string 8",
      "Address4": "sample string 9",
      "Address5": "sample string 10",
      "PostCode": "sample string 11",
      "Gender": "sample string 12",
      "Source": "sample string 13",
      "Date_of_Birth": "sample string 14",
      "Date_of_Death": "sample string 15"
    }
  ],
  "ErrorCount": 2,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"ResultCount":2,"Results":[{"Unique_Reference_Number":"sample string 1","Title":"sample string 2","Forename":"sample string 3","Middlename":"sample string 4","Surname":"sample string 5","Address1":"sample string 6","Address2":"sample string 7","Address3":"sample string 8","Address4":"sample string 9","Address5":"sample string 10","PostCode":"sample string 11","Gender":"sample string 12","Source":"sample string 13","Date_of_Birth":"sample string 14","Date_of_Death":"sample string 15"},{"Unique_Reference_Number":"sample string 1","Title":"sample string 2","Forename":"sample string 3","Middlename":"sample string 4","Surname":"sample string 5","Address1":"sample string 6","Address2":"sample string 7","Address3":"sample string 8","Address4":"sample string 9","Address5":"sample string 10","PostCode":"sample string 11","Gender":"sample string 12","Source":"sample string 13","Date_of_Birth":"sample string 14","Date_of_Death":"sample string 15"}],"ErrorCount":2,"Errors":["sample string 1","sample string 2"]}