API Docs
YMS API
Data Models
Appointment
Page Result Appointment View

PageResultAppointmentView

{
  "list": [
    {
      "id": 0,
      "appointmentId": "string",
      "appointmentType": "INBOUND",
      "carrierId": "string",
      "carrierName": "string",
      "finalCarrierId": "string",
      "subCarrierName": "string",
      "appointmentTime": "string",
      "appointmentStatus": "NEW",
      "customerIds": [
        "string"
      ],
      "externalId": 0,
      "entryId": "string",
      "referenceCode": "string",
      "driverId": "string",
      "createdTime": "string",
      "createdBy": "string",
      "updatedTime": "string",
      "updatedBy": "string",
      "customerNames": [
        "string"
      ],
      "appointmentActionViews": [
        {
          "id": 0,
          "appointmentId": "string",
          "appointmentType": "INBOUND",
          "serviceType": "string",
          "appointmentTime": "string",
          "referenceIds": [
            "string"
          ],
          "createdTime": "string",
          "createdBy": "string",
          "updatedTime": "string",
          "updatedBy": "string",
          "loadViews": [
            {}
          ],
          "receiptViews": [
            {}
          ]
        }
      ],
      "driverSnapshot": "string",
      "driverSnapshotParse": {
        "driverId": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "driverPhone": "string",
        "phone": "string",
        "licenseNumber": "string",
        "licenseExpirationDate": "string",
        "licenseState": "string",
        "email": "string",
        "licensePlate": "ABC123",
        "carrierName": "string",
        "carrierId": "string",
        "usdot": "string",
        "equipmentNo": "string",
        "equipmentType": "VEHICLE",
        "cargoStatus": "UNKNOWN"
      },
      "serviceTypes": [
        "string"
      ],
      "checkedInTime": "string",
      "carrierFinishTime": "string",
      "driverFinishTime": "string",
      "finalCarrierView": {
        "carrierId": "string",
        "carrierName": "string",
        "scac": [
          "string"
        ],
        "usdot": "string",
        "mcNumber": "string",
        "verified": true,
        "createdTime": "string",
        "createdBy": "string",
        "updatedTime": "string",
        "updatedBy": "string",
        "carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
        "knownName": "string",
        "orgIds": [
          "string"
        ]
      },
      "cargoStatus": "UNKNOWN",
      "notes": "string"
    }
  ],
  "totalCount": 0,
  "currentPage": 0,
  "pageSize": 0,
  "totalPage": 0
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
list[AppointmentView (opens in a new tab)]falsenonenone
totalCountinteger(int64)falsenonenone
currentPageinteger(int64)falsenonenone
pageSizeinteger(int64)falsenonenone
totalPageinteger(int64)falsenonenone