back

Advanced Search Records

Scope: search_records
App Type: All
Authorization Type: Access token
Url: v3/search/records?expand={expand}&lang={lang}&offset={offset}&limit={limit}
HTTP Method: POST

Request Information

Parameters

application/json

{
  "filter": {
    "ids": [
      "sample string 1"
    ],
    "types": [
      "sample string 1"
    ],
    "statuses": [
      "sample string 1"
    ],
    "parcelNumber": "sample string 1",
    "aliases": [
      "sample string 1"
    ],
    "staffIds": [
      "sample string 1"
    ],
    "streetName": "sample string 2",
    "streetDirection": "sample string 3",
    "houseNumber": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zipCode": "sample string 7",
    "firstName": "sample string 8",
    "middleName": "sample string 9",
    "lastName": "sample string 10",
    "openedDateFrom": "sample string 11",
    "openedDateTo": "sample string 12",
    "scheduledDateFrom": "sample string 13",
    "scheduledDateTo": "sample string 14",
    "module": "sample string 15",
    "bBox": {
      "xMax": "sample string 1",
      "xMin": "sample string 2",
      "yMax": "sample string 3",
      "yMin": "sample string 4"
    },
    "geoCircle": {
      "centerX": "sample string 1",
      "centerY": "sample string 2",
      "radius": "sample string 3"
    }
  }
}

Response Information

application/json

{
  "page": {
    "totalRows": 1,
    "hasMore": true
  },
  "records": [
    {
      "addresses": [
        {
          "id": "sample string 1",
          "display": "sample string 2",
          "addressFormat": "sample string 3",
          "houseNumber": "sample string 4",
          "houseNumberFraction": "sample string 5",
          "streetDirection": "sample string 6",
          "streetName": "sample string 7",
          "streetSuffix": "sample string 8",
          "streetSuffixDirection": "sample string 9",
          "unit": "sample string 10",
          "unitEnd": "sample string 11",
          "unitType": "sample string 12",
          "state": "sample string 13",
          "postalCode": "sample string 14",
          "city": "sample string 15",
          "county": "sample string 16",
          "country": "sample string 17",
          "isPrimary": "sample string 18",
          "xCoordinate": "sample string 19",
          "yCoordinate": "sample string 20",
          "enabled": true,
          "entityState": "sample string 22"
        }
      ],
      "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": "10cc6321-ae6c-465b-883e-1d6b9a569d48",
        "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"
    }
  ]
}