GET api/HaloProbatePlus/Retrieve?AuthKey={AuthKey}&Product={Product}&URN={URN}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthKey | globally unique identifier |
None. |
|
| Product | string |
None. |
|
| URN | string |
None. |
Body Parameters
None.
Response Information
Resource Description
HaloProbatePlusProductResult| Name | Description | 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": [
{
"URN": "sample string 1",
"CASE_REFERENCE_NUMBER": "sample string 2",
"FORENAME": "sample string 3",
"MIDDLENAME": "sample string 4",
"SURNAME": "sample string 5",
"FULL_NAME_OF_DECEASED": "sample string 6",
"ALL_NAMES_WHICH_THE_DECEASED_WAS_OTHERWISE_KNOWN_AS": "sample string 7",
"ADDRESS1": "sample string 8",
"ADDRESS2": "sample string 9",
"ADDRESS3": "sample string 10",
"ADDRESS4": "sample string 11",
"ADDRESS5": "sample string 12",
"POSTCODE": "sample string 13",
"COUNTRY": "sample string 14",
"REGISTRY_NAME": "sample string 15",
"TYPE_OF_GRANT": "sample string 16",
"DATE_OF_ISSUE": "sample string 17",
"DATE_OF_DEATH": "sample string 18",
"DATE_OF_BIRTH": "sample string 19",
"GROSS": "sample string 20",
"NET": "sample string 21",
"APPLYING_EXECUTOR_1_NAME": "sample string 22",
"APPLYING_EXECUTOR_1_ADDRESS": "sample string 23",
"APPLYING_EXECUTOR_1_TOWN": "sample string 24",
"APPLYING_EXECUTOR_1_COUNTY": "sample string 25",
"APPLYING_EXECUTOR_1_POSTCODE": "sample string 26",
"APPLYING_EXECUTOR_1_COUNTRY": "sample string 27",
"APPLYING_EXECUTOR_2_NAME": "sample string 28",
"APPLYING_EXECUTOR_2_ADDRESS": "sample string 29",
"APPLYING_EXECUTOR_2_TOWN": "sample string 30",
"APPLYING_EXECUTOR_2_COUNTY": "sample string 31",
"APPLYING_EXECUTOR_2_POSTCODE": "sample string 32",
"APPLYING_EXECUTOR_2_COUNTRY": "sample string 33",
"APPLYING_EXECUTOR_3_NAME": "sample string 34",
"APPLYING_EXECUTOR_3_ADDRESS": "sample string 35",
"APPLYING_EXECUTOR_3_TOWN": "sample string 36",
"APPLYING_EXECUTOR_3_COUNTY": "sample string 37",
"APPLYING_EXECUTOR_3_POSTCODE": "sample string 38",
"APPLYING_EXECUTOR_3_COUNTRY": "sample string 39",
"PRIMARY_APPLICANT_NAME": "sample string 40",
"PRIMARY_APPLICANT_ADDRESS": "sample string 41",
"PRIMARY_APPLICANT_TOWN": "sample string 42",
"PRIMARY_APPLICANT_COUNTY": "sample string 43",
"PRIMARY_APPLICANT_POSTCODE": "sample string 44",
"PRIMARY_APPLICANT_COUNTRY": "sample string 45",
"SOLICITOR_NAME": "sample string 46",
"SOLICITOR_REFERENCE": "sample string 47",
"SOLICITOR_ADDRESS": "sample string 48",
"SOLICITOR_TOWN": "sample string 49",
"SOLICITOR_COUNTY": "sample string 50",
"SOLICITOR_POSTCODE": "sample string 51",
"SOLICITOR_COUNTRY": "sample string 52"
},
{
"URN": "sample string 1",
"CASE_REFERENCE_NUMBER": "sample string 2",
"FORENAME": "sample string 3",
"MIDDLENAME": "sample string 4",
"SURNAME": "sample string 5",
"FULL_NAME_OF_DECEASED": "sample string 6",
"ALL_NAMES_WHICH_THE_DECEASED_WAS_OTHERWISE_KNOWN_AS": "sample string 7",
"ADDRESS1": "sample string 8",
"ADDRESS2": "sample string 9",
"ADDRESS3": "sample string 10",
"ADDRESS4": "sample string 11",
"ADDRESS5": "sample string 12",
"POSTCODE": "sample string 13",
"COUNTRY": "sample string 14",
"REGISTRY_NAME": "sample string 15",
"TYPE_OF_GRANT": "sample string 16",
"DATE_OF_ISSUE": "sample string 17",
"DATE_OF_DEATH": "sample string 18",
"DATE_OF_BIRTH": "sample string 19",
"GROSS": "sample string 20",
"NET": "sample string 21",
"APPLYING_EXECUTOR_1_NAME": "sample string 22",
"APPLYING_EXECUTOR_1_ADDRESS": "sample string 23",
"APPLYING_EXECUTOR_1_TOWN": "sample string 24",
"APPLYING_EXECUTOR_1_COUNTY": "sample string 25",
"APPLYING_EXECUTOR_1_POSTCODE": "sample string 26",
"APPLYING_EXECUTOR_1_COUNTRY": "sample string 27",
"APPLYING_EXECUTOR_2_NAME": "sample string 28",
"APPLYING_EXECUTOR_2_ADDRESS": "sample string 29",
"APPLYING_EXECUTOR_2_TOWN": "sample string 30",
"APPLYING_EXECUTOR_2_COUNTY": "sample string 31",
"APPLYING_EXECUTOR_2_POSTCODE": "sample string 32",
"APPLYING_EXECUTOR_2_COUNTRY": "sample string 33",
"APPLYING_EXECUTOR_3_NAME": "sample string 34",
"APPLYING_EXECUTOR_3_ADDRESS": "sample string 35",
"APPLYING_EXECUTOR_3_TOWN": "sample string 36",
"APPLYING_EXECUTOR_3_COUNTY": "sample string 37",
"APPLYING_EXECUTOR_3_POSTCODE": "sample string 38",
"APPLYING_EXECUTOR_3_COUNTRY": "sample string 39",
"PRIMARY_APPLICANT_NAME": "sample string 40",
"PRIMARY_APPLICANT_ADDRESS": "sample string 41",
"PRIMARY_APPLICANT_TOWN": "sample string 42",
"PRIMARY_APPLICANT_COUNTY": "sample string 43",
"PRIMARY_APPLICANT_POSTCODE": "sample string 44",
"PRIMARY_APPLICANT_COUNTRY": "sample string 45",
"SOLICITOR_NAME": "sample string 46",
"SOLICITOR_REFERENCE": "sample string 47",
"SOLICITOR_ADDRESS": "sample string 48",
"SOLICITOR_TOWN": "sample string 49",
"SOLICITOR_COUNTY": "sample string 50",
"SOLICITOR_POSTCODE": "sample string 51",
"SOLICITOR_COUNTRY": "sample string 52"
}
],
"ErrorCount": 2,
"Errors": [
"sample string 1",
"sample string 2"
]
}
text/html
Sample:
{"ResultCount":2,"Results":[{"URN":"sample string 1","CASE_REFERENCE_NUMBER":"sample string 2","FORENAME":"sample string 3","MIDDLENAME":"sample string 4","SURNAME":"sample string 5","FULL_NAME_OF_DECEASED":"sample string 6","ALL_NAMES_WHICH_THE_DECEASED_WAS_OTHERWISE_KNOWN_AS":"sample string 7","ADDRESS1":"sample string 8","ADDRESS2":"sample string 9","ADDRESS3":"sample string 10","ADDRESS4":"sample string 11","ADDRESS5":"sample string 12","POSTCODE":"sample string 13","COUNTRY":"sample string 14","REGISTRY_NAME":"sample string 15","TYPE_OF_GRANT":"sample string 16","DATE_OF_ISSUE":"sample string 17","DATE_OF_DEATH":"sample string 18","DATE_OF_BIRTH":"sample string 19","GROSS":"sample string 20","NET":"sample string 21","APPLYING_EXECUTOR_1_NAME":"sample string 22","APPLYING_EXECUTOR_1_ADDRESS":"sample string 23","APPLYING_EXECUTOR_1_TOWN":"sample string 24","APPLYING_EXECUTOR_1_COUNTY":"sample string 25","APPLYING_EXECUTOR_1_POSTCODE":"sample string 26","APPLYING_EXECUTOR_1_COUNTRY":"sample string 27","APPLYING_EXECUTOR_2_NAME":"sample string 28","APPLYING_EXECUTOR_2_ADDRESS":"sample string 29","APPLYING_EXECUTOR_2_TOWN":"sample string 30","APPLYING_EXECUTOR_2_COUNTY":"sample string 31","APPLYING_EXECUTOR_2_POSTCODE":"sample string 32","APPLYING_EXECUTOR_2_COUNTRY":"sample string 33","APPLYING_EXECUTOR_3_NAME":"sample string 34","APPLYING_EXECUTOR_3_ADDRESS":"sample string 35","APPLYING_EXECUTOR_3_TOWN":"sample string 36","APPLYING_EXECUTOR_3_COUNTY":"sample string 37","APPLYING_EXECUTOR_3_POSTCODE":"sample string 38","APPLYING_EXECUTOR_3_COUNTRY":"sample string 39","PRIMARY_APPLICANT_NAME":"sample string 40","PRIMARY_APPLICANT_ADDRESS":"sample string 41","PRIMARY_APPLICANT_TOWN":"sample string 42","PRIMARY_APPLICANT_COUNTY":"sample string 43","PRIMARY_APPLICANT_POSTCODE":"sample string 44","PRIMARY_APPLICANT_COUNTRY":"sample string 45","SOLICITOR_NAME":"sample string 46","SOLICITOR_REFERENCE":"sample string 47","SOLICITOR_ADDRESS":"sample string 48","SOLICITOR_TOWN":"sample string 49","SOLICITOR_COUNTY":"sample string 50","SOLICITOR_POSTCODE":"sample string 51","SOLICITOR_COUNTRY":"sample string 52"},{"URN":"sample string 1","CASE_REFERENCE_NUMBER":"sample string 2","FORENAME":"sample string 3","MIDDLENAME":"sample string 4","SURNAME":"sample string 5","FULL_NAME_OF_DECEASED":"sample string 6","ALL_NAMES_WHICH_THE_DECEASED_WAS_OTHERWISE_KNOWN_AS":"sample string 7","ADDRESS1":"sample string 8","ADDRESS2":"sample string 9","ADDRESS3":"sample string 10","ADDRESS4":"sample string 11","ADDRESS5":"sample string 12","POSTCODE":"sample string 13","COUNTRY":"sample string 14","REGISTRY_NAME":"sample string 15","TYPE_OF_GRANT":"sample string 16","DATE_OF_ISSUE":"sample string 17","DATE_OF_DEATH":"sample string 18","DATE_OF_BIRTH":"sample string 19","GROSS":"sample string 20","NET":"sample string 21","APPLYING_EXECUTOR_1_NAME":"sample string 22","APPLYING_EXECUTOR_1_ADDRESS":"sample string 23","APPLYING_EXECUTOR_1_TOWN":"sample string 24","APPLYING_EXECUTOR_1_COUNTY":"sample string 25","APPLYING_EXECUTOR_1_POSTCODE":"sample string 26","APPLYING_EXECUTOR_1_COUNTRY":"sample string 27","APPLYING_EXECUTOR_2_NAME":"sample string 28","APPLYING_EXECUTOR_2_ADDRESS":"sample string 29","APPLYING_EXECUTOR_2_TOWN":"sample string 30","APPLYING_EXECUTOR_2_COUNTY":"sample string 31","APPLYING_EXECUTOR_2_POSTCODE":"sample string 32","APPLYING_EXECUTOR_2_COUNTRY":"sample string 33","APPLYING_EXECUTOR_3_NAME":"sample string 34","APPLYING_EXECUTOR_3_ADDRESS":"sample string 35","APPLYING_EXECUTOR_3_TOWN":"sample string 36","APPLYING_EXECUTOR_3_COUNTY":"sample string 37","APPLYING_EXECUTOR_3_POSTCODE":"sample string 38","APPLYING_EXECUTOR_3_COUNTRY":"sample string 39","PRIMARY_APPLICANT_NAME":"sample string 40","PRIMARY_APPLICANT_ADDRESS":"sample string 41","PRIMARY_APPLICANT_TOWN":"sample string 42","PRIMARY_APPLICANT_COUNTY":"sample string 43","PRIMARY_APPLICANT_POSTCODE":"sample string 44","PRIMARY_APPLICANT_COUNTRY":"sample string 45","SOLICITOR_NAME":"sample string 46","SOLICITOR_REFERENCE":"sample string 47","SOLICITOR_ADDRESS":"sample string 48","SOLICITOR_TOWN":"sample string 49","SOLICITOR_COUNTY":"sample string 50","SOLICITOR_POSTCODE":"sample string 51","SOLICITOR_COUNTRY":"sample string 52"}],"ErrorCount":2,"Errors":["sample string 1","sample string 2"]}