API Docs
YMS API
Data Models
Appointment
Appointment Change Create CMD

AppointmentChangeCreateCmd

{
  "appointmentId": "string",
  "changeType": "UPDATE",
  "appointmentTimeFrom": "string",
  "appointmentTimeTo": "string",
  "missAppointment": true,
  "note": "string",
  "reason": "string",
  "receiptIds": [
    "string"
  ],
  "loadIds": [
    "string"
  ],
  "originalInboundAction": "string",
  "originalReceiptIds": [
    "string"
  ],
  "originalOutboundAction": "string",
  "originalLoadIds": [
    "string"
  ],
  "nowInboundAction": "string",
  "nowOutboundAction": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
appointmentIdstringtruenoneAppointment identifier
changeTypestringfalsenoneType of change made
appointmentTimeFromstringfalsenoneOriginal appointment time
appointmentTimeTostringfalsenoneNew appointment time
missAppointmentbooleanfalsenoneFlag indicating if appointment time was missed
notestringfalsenoneAdditional notes or comments
reasonstringfalsenoneReason for the change
receiptIds[string]falsenoneCurrent receipt IDs
loadIds[string]falsenoneCurrent load IDs
originalInboundActionstringfalsenoneOriginal inbound action
originalReceiptIds[string]falsenoneOriginal receipt IDs
originalOutboundActionstringfalsenoneOriginal outbound action
originalLoadIds[string]falsenoneOriginal load IDs
nowInboundActionstringfalsenoneCurrent inbound action at the time of change
nowOutboundActionstringfalsenoneCurrent outbound action at the time of change

Enum Values

PropertyValue
changeTypeUPDATE
changeTypeCANCEL
changeTypeASSIGN_DRIVER
changeTypeCOMPLETE_PRE_CHECK_IN
changeTypeCOMPLETE_CHECK_IN