back

Schedule Inspection

Scope: create_inspection
App Type: Agency
Authorization Type: Access token
Url: v3/inspections?lang={lang}
HTTP Method: POST

Request Information

Parameters

application/json

{
  "createInspection": {
    "inspectionTypeId": "sample string 1",
    "recordId": "sample string 2",
    "autoAssign": true,
    "checklists": [
      {
        "checklistItems": [
          {
            "additionalVisible": true,
            "id": "sample string 2",
            "content": "sample string 3",
            "status": {
              "id": "sample string 1",
              "display": "sample string 2",
              "type": "sample string 3",
              "defaultScore": 1.1
            },
            "comments": "sample string 4",
            "maxScore": 1.1,
            "score": 1.1,
            "statusVisible": true,
            "commentVisible": true,
            "scoreVisible": true,
            "statusGroup": {
              "id": "sample string 1",
              "display": "sample string 2",
              "checklistItemStatuses": [
                {
                  "id": "sample string 1",
                  "display": "sample string 2",
                  "type": "sample string 3",
                  "defaultScore": 1.1
                }
              ]
            },
            "entityState": "sample string 8"
          }
        ],
        "id": "sample string 1",
        "subject": "sample string 2",
        "label": "sample string 3",
        "totalScore": 1.1,
        "entityState": "sample string 4"
      }
    ],
    "sequenceNumber": "sample string 4",
    "scheduleDate": "sample string 5",
    "scheduleTime": "sample string 6",
    "scheduleNotes": "sample string 7",
    "address": "sample string 8",
    "detailAddress": {
      "addressFormat": "sample string 1",
      "City": "sample string 2",
      "Country": "sample string 3",
      "County": "sample string 4",
      "houseNumber": "sample string 5",
      "houseNumberFraction": "sample string 6",
      "id": "sample string 7",
      "PostalCode": "sample string 8",
      "State": "sample string 9",
      "streetDirection": "sample string 10",
      "streetName": "sample string 11",
      "streetSuffix": "sample string 12",
      "streetSuffixDirection": "sample string 13",
      "unit": "sample string 14",
      "unitEnd": "sample string 15",
      "unitType": "sample string 16",
      "urbanization": "sample string 17",
      "XCoordinate": "sample string 18",
      "YCoordinate": "sample string 19",
      "isPrimary": true,
      "ReferenceAddressType": "sample string 2"
    },
    "department": "sample string 9",
    "inspector": {
      "id": "sample string 1",
      "display": "sample string 2"
    },
    "inspectionUnit": "sample string 10",
    "requestorPhoneNumber": "sample string 11",
    "contactName": "sample string 12",
    "contactFirstName": "sample string 13",
    "contactMiddleName": "sample string 14",
    "contactLastName": "sample string 15",
    "contactPhoneNumber": "sample string 16",
    "licensedProfessional": "sample string 17",
    "latitude": "sample string 18",
    "longitude": "sample string 19",
    "comments": [
      {
        "fillDate": "sample string 1",
        "fillPeopleName": "sample string 2",
        "content": "sample string 3",
        "entityState": "sample string 4"
      }
    ],
    "priority": "sample string 20"
  }
}

Response Information

application/json

{
  "inspection": {
    "id": "sample string 1",
    "display": "sample string 2",
    "contextType": "sample string 3",
    "type": {
      "id": "sample string 1",
      "display": "sample string 2"
    },
    "status": {
      "type": "sample string 1",
      "id": "sample string 2",
      "display": "sample string 3"
    },
    "recordId": "sample string 4",
    "recordIdDisplay": "sample string 5",
    "resultDate": "sample string 6",
    "record": {
      "id": "sample string 1",
      "display": "sample string 2",
      "name": "sample string 3",
      "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"
        ]
      }
    },
    "sequenceNumber": "sample string 7",
    "scheduleDate": "sample string 8",
    "scheduleTime": "sample string 9",
    "scheduleNotes": "sample string 10",
    "address": "sample string 11",
    "detailAddress": {
      "addressFormat": "sample string 1",
      "City": "sample string 2",
      "Country": "sample string 3",
      "County": "sample string 4",
      "houseNumber": "sample string 5",
      "houseNumberFraction": "sample string 6",
      "id": "sample string 7",
      "PostalCode": "sample string 8",
      "State": "sample string 9",
      "streetDirection": "sample string 10",
      "streetName": "sample string 11",
      "streetSuffix": "sample string 12",
      "streetSuffixDirection": "sample string 13",
      "unit": "sample string 14",
      "unitEnd": "sample string 15",
      "unitType": "sample string 16",
      "urbanization": "sample string 17",
      "XCoordinate": "sample string 18",
      "YCoordinate": "sample string 19",
      "isPrimary": true,
      "ReferenceAddressType": "sample string 2"
    },
    "department": "sample string 12",
    "inspector": {
      "id": "sample string 1",
      "display": "sample string 2"
    },
    "inspectionUnit": "sample string 13",
    "requestorPhoneNumber": "sample string 14",
    "contactName": "sample string 15",
    "contactFirstName": "sample string 16",
    "contactMiddleName": "sample string 17",
    "contactLastName": "sample string 18",
    "contactPhoneNumber": "sample string 19",
    "licensedProfessional": "sample string 20",
    "latitude": "sample string 21",
    "longitude": "sample string 22",
    "comments": [
      {
        "fillDate": "sample string 1",
        "fillPeopleName": "sample string 2",
        "content": "sample string 3",
        "entityState": "sample string 4"
      }
    ],
    "priority": "sample string 23"
  }
}