API Docs
YMS API
Data Models
Appointment
Appointment Create CMD

AppointmentCreateCmd

{
  "appointmentTime": "string",
  "carrierId": "string",
  "customerIds": [
    "string"
  ],
  "inboundAction": {
    "appointmentId": "string",
    "appointmentType": "INBOUND",
    "serviceType": "string",
    "appointmentTime": "string",
    "referenceIds": [
      "string"
    ],
    "customerIds": [
      "string"
    ]
  },
  "outboundAction": {
    "appointmentId": "string",
    "appointmentType": "INBOUND",
    "serviceType": "string",
    "appointmentTime": "string",
    "referenceIds": [
      "string"
    ],
    "customerIds": [
      "string"
    ]
  },
  "appointmentType": "INBOUND",
  "notes": "string",
  "operator": "CARRIER"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
appointmentTimestringtruenoneScheduled appointment time
carrierIdstringtruenoneCarrier identifier
customerIds[string]falsenoneList of customer identifiers
inboundActionAppointmentActionCreateCmd (opens in a new tab)falsenoneInbound action details, only present when appointmentType is INBOUND or BOTH
outboundActionAppointmentActionCreateCmd (opens in a new tab)falsenoneOutbound action details, only present when appointmentType is OUTBOUND or BOTH
appointmentTypestringfalsenoneAppointment type
notesstringfalsenoneNote or remarks for the appointment
operatorstringfalsenoneOperator who creates the appointment (carrier, customer, or internal). Not persisted to database.

Enum Values

PropertyValue
appointmentTypeINBOUND
appointmentTypeOUTBOUND
appointmentTypeBOTH
operatorCARRIER
operatorCUSTOMER
operatorINTERNAL