GET api/Mortascreen/Retrieve?AuthKey={AuthKey}&Product={Product}&URN={URN}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AuthKey

globally unique identifier

None.

Product

string

None.

URN

string

None.

Body Parameters

None.

Response Information

Resource Description

MortascreenProductResult
NameDescriptionTypeAdditional information
ResultCount

integer

None.

Results

Collection of MortascreenResultRow

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"]}