CancelAppointment - Cancels appointment moves or an entire visit

Request

Cancels either individual moves or the entire appointment (visit) depending on the provided input. Supports two ways of identifying what should be canceled:

gateApptIdList: Cancel specific moves by Gate Appointment ID.
truckVisitIdList: Cancel the entire visit by Truck Visit ID. Each entry requires an Id and either MTO_Id or MTO_Cd to identify the terminal.

Headers

X-Cargosprint-Api-Keystringrequired

The company API key provided by Cargosprint.

X-Cargosprint-User-Keystringrequired

The API key of the user to be impersonated.

Bodyapplication/json

The request containing the gate appointment IDs or truck visit IDs to cancel.

gateApptIdListArray of objects or null(ApptRequest)

truckVisitIdListArray of objects or null(ApptRequest)

curl -i -X POST \
  https://developer.cargosprint.com/_mock/pregate/openapi/api/appointment/cancelappointment \
  -H 'Content-Type: application/json' \
  -H 'X-Cargosprint-Api-Key: string' \
  -H 'X-Cargosprint-User-Key: string' \
  -d '{
    "gateApptIdList": [
      {
        "id": 0,
        "mtO_Id": 0,
        "mtO_Cd": "string"
      }
    ],
    "truckVisitIdList": [
      {
        "id": 0,
        "mtO_Id": 0,
        "mtO_Cd": "string"
      }
    ]
  }'

Responses

Appointment cancelled successfully.

Bodyapplication/json

todayArray of objects or null(TimeSlot)

tomorrowArray of objects or null(TimeSlot)

Response

{
  "today": [
    { … }
  ],
  "tomorrow": [
    { … }
  ]
}