Global property history reporting and due-diligence API

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Update API Calls

Update Person

POST /update/person/{personid}

Purpose

To update information stored about a person on the API.

Inputs

Any combination of the following inputs can be sent to the API to update a person.

Example Request


POST /update/person/42 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "familyname": "Bloggs",
    "othernames": "Joseph Anders",
    "dob": "1982-11-25",
    "gender": "Male",
    "ref": "QWERTY12344"
}

Output

If successful then there will be no output from this method other than a 200 OK HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

Example Responses

Response on Success:

HTTP/1.1 200 OK
Content-Type: application/json


Response on Error:

HTTP/1.1 400 Human readable error message
Content-Type: application/json

{
    "errors":
    [
        {
            "id": n,
            "message": "Human readable message"
        }
    ]
}

Update Property

POST /update/property/{propertyid}

Purpose

To update information stored about a person on the API.

Inputs

Any combination of the following inputs can be sent to the API to update property.

Example Request


POST /update/property/123 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "personid": 234,
    "category": 1,
    "make": "Samsung",
    "model": "Omnia",
    "description": "Samsung Omnia cellular phone",
    "serials": "QWERTY12344"
}

Output

If successful then there will be no output from this method other than a 200 OK HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

Example Responses

Response on Success:

HTTP/1.1 200 OK
Content-Type: application/json


Response on Error:

HTTP/1.1 400 Human readable error message
Content-Type: application/json

{
    "errors":
    [
        {
            "id": n,
            "message": "Human readable message"
        }
    ]
}