back

Get Related Records

Scope: get_related_records
App Type: Agency
Authorization Type: Access token
Url: v3/records/{id}/related?lang={lang}
HTTP Method: GET

Response Information

application/json

{
  "records": [
    {
      "related": [
        {
          "id": "sample string 1",
          "relationship": "sample string 2"
        }
      ],
      "display": "sample string 1",
      "module": "sample string 2",
      "name": "sample string 3",
      "assignToInfo": {
        "totalJobCost": "sample string 1",
        "completeDate": "sample string 2",
        "AssignDate": "sample string 3",
        "scheduledDate": "sample string 4",
        "assignStaff": "sample string 5",
        "assignDepartment": "sample string 6",
        "priority": "sample string 7"
      },
      "user": {
        "firstName": "sample string 1",
        "lastName": "sample string 2",
        "civicId": "ecafd52f-4160-4eec-89b7-f3d3c0508ee0",
        "email": "sample string 4"
      },
      "createdDate": "sample string 4",
      "id": "sample string 5",
      "description": "sample string 6",
      "isPrivate": true,
      "type": {
        "id": "sample string 1",
        "display": "sample string 2",
        "module": "sample string 3",
        "group": "sample string 4",
        "subGroup": "sample string 5",
        "category": "sample string 6",
        "type": "sample string 7",
        "security": "sample string 8",
        "inspectionGroups": [
          "sample string 1"
        ],
        "standardCommentsGroupIds": [
          "sample string 1"
        ]
      },
      "status": {
        "id": "sample string 1",
        "display": "sample string 2"
      },
      "department": {
        "id": "sample string 1",
        "display": "sample string 2",
        "agency": "sample string 3",
        "bureau": "sample string 4",
        "division": "sample string 5",
        "section": "sample string 6",
        "group": "sample string 7",
        "subGroup": "sample string 8",
        "subGroupDescription": "sample string 9"
      },
      "staffPerson": {
        "id": "sample string 1",
        "display": "sample string 2",
        "agencyCode": "sample string 3",
        "auditStatus": "sample string 4",
        "bureauCode": "sample string 5",
        "divisionCode": "sample string 6",
        "firstName": "sample string 7",
        "groupCode": "sample string 8",
        "lastName": "sample string 9",
        "officeCode": "sample string 10",
        "sectionCode": "sample string 11",
        "serviceProviderCode": "sample string 12",
        "userStatus": "sample string 13"
      },
      "assignDate": "sample string 8",
      "scheduleDate": "sample string 9",
      "scheduleTime": "sample string 10",
      "openDate": "sample string 11",
      "priority": "sample string 12",
      "shortNotes": "sample string 13",
      "templateName": "sample string 14"
    }
  ]
}