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.

Dump API Calls

Dump Organisation's Structure

POST /dump/organisation/{orgid}

Purpose

To return a representation of an organisations structure using a supplied organisation ID as a starting point. This includes the starting organisation, the child organisations relating to the starting organisation and the stores relating to the starting organisation and its children.

Inputs

Example Request


curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/dump/organisation/0

Output

A JSON object representing the structure of the organisation specified in the request method. The output array structure is recursive. For each child organisation it will include the organisations that are a child to the child organisation as well as the stores registered to that child's ID.

Example Response


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

{
    "organisations":
    [
        {
            "id":"1",
            "legal_name":"Amce Traders Inc.",
            "report_name":"Amce Traders",
            "child_organisations":null,
            "stores":
            [
                {
                    "id":"3",
                    "legal_name":"Amce Traders Inc.",
                    "report_name":"Amce Traders"
                }
            ]
        },
        {
            "id":"6",
            "legal_name":"Amce Traders Inc.",
            "report_name":"Amce Traders",
            "child_organisations":null,
            "stores":null
        }
    ]
}