POST api/HaloProbatePlus/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": "c744aeaf-e860-4c2b-b7bd-ac3203655fe1",
  "Product": "sample string 2",
  "URN": "sample string 3"
}

text/html

Sample:

{"AuthKey":"c744aeaf-e860-4c2b-b7bd-ac3203655fe1","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>c744aeaf-e860-4c2b-b7bd-ac3203655fe1</AuthKey>
</RetrieveParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HaloProbatePlusProductResult

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

Response Formats

application/json, text/json

Sample:

{
  "ResultCount": 2,
  "Results": [
    {
      "ProbateID": "sample string 1",
      "Forename1": "sample string 2",
      "Forename2": "sample string 3",
      "Surname": "sample string 4",
      "AlsoKnownAs1": "sample string 5",
      "AlsoKnownAs2": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Address3": "sample string 9",
      "Address4": "sample string 10",
      "Address5": "sample string 11",
      "Postcode": "sample string 12",
      "Gender": "sample string 13",
      "Date_Of_Birth": "sample string 14",
      "Date_Of_Death": "sample string 15",
      "Age": "sample string 16",
      "ProbateFullName": "sample string 17",
      "Registry": "sample string 18",
      "Intestate": "sample string 19",
      "Gross": "sample string 20",
      "Net": "sample string 21",
      "Probate_Registry_Number": "sample string 22",
      "Date_Of_Probate": "sample string 23",
      "Document_Type": "sample string 24",
      "URN": "sample string 25"
    },
    {
      "ProbateID": "sample string 1",
      "Forename1": "sample string 2",
      "Forename2": "sample string 3",
      "Surname": "sample string 4",
      "AlsoKnownAs1": "sample string 5",
      "AlsoKnownAs2": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Address3": "sample string 9",
      "Address4": "sample string 10",
      "Address5": "sample string 11",
      "Postcode": "sample string 12",
      "Gender": "sample string 13",
      "Date_Of_Birth": "sample string 14",
      "Date_Of_Death": "sample string 15",
      "Age": "sample string 16",
      "ProbateFullName": "sample string 17",
      "Registry": "sample string 18",
      "Intestate": "sample string 19",
      "Gross": "sample string 20",
      "Net": "sample string 21",
      "Probate_Registry_Number": "sample string 22",
      "Date_Of_Probate": "sample string 23",
      "Document_Type": "sample string 24",
      "URN": "sample string 25"
    }
  ],
  "ErrorCount": 2,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"ResultCount":2,"Results":[{"ProbateID":"sample string 1","Forename1":"sample string 2","Forename2":"sample string 3","Surname":"sample string 4","AlsoKnownAs1":"sample string 5","AlsoKnownAs2":"sample string 6","Address1":"sample string 7","Address2":"sample string 8","Address3":"sample string 9","Address4":"sample string 10","Address5":"sample string 11","Postcode":"sample string 12","Gender":"sample string 13","Date_Of_Birth":"sample string 14","Date_Of_Death":"sample string 15","Age":"sample string 16","ProbateFullName":"sample string 17","Registry":"sample string 18","Intestate":"sample string 19","Gross":"sample string 20","Net":"sample string 21","Probate_Registry_Number":"sample string 22","Date_Of_Probate":"sample string 23","Document_Type":"sample string 24","URN":"sample string 25"},{"ProbateID":"sample string 1","Forename1":"sample string 2","Forename2":"sample string 3","Surname":"sample string 4","AlsoKnownAs1":"sample string 5","AlsoKnownAs2":"sample string 6","Address1":"sample string 7","Address2":"sample string 8","Address3":"sample string 9","Address4":"sample string 10","Address5":"sample string 11","Postcode":"sample string 12","Gender":"sample string 13","Date_Of_Birth":"sample string 14","Date_Of_Death":"sample string 15","Age":"sample string 16","ProbateFullName":"sample string 17","Registry":"sample string 18","Intestate":"sample string 19","Gross":"sample string 20","Net":"sample string 21","Probate_Registry_Number":"sample string 22","Date_Of_Probate":"sample string 23","Document_Type":"sample string 24","URN":"sample string 25"}],"ErrorCount":2,"Errors":["sample string 1","sample string 2"]}