FacilityAppointment
Facility appointment model.
- createdType: stringFormat: date-time
_at read-onlyrequiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- facilityType: stringFormat: uuidrequired
- idType: stringFormat: uuidrequired
- isType: boolean
_work _in required - orderType: array object[]
_info required- idType: stringFormat: uuidrequired
- referenceType: string
_id required
- recurringType: object
_facility _appointment required- repetitionType: stringenum
_type requiredvalues- Daily
- Weekly
- idType: stringFormat: uuid
- scheduledType: stringFormat: date-time
_end _time requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- scheduledType: stringFormat: date-time
_start _time requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- statusType: stringenumread-onlyrequired
Statuses are roughly ordered in the way they will flow through the lifecycle of the appointment.
Status Description Requested Scheduled but pending approval by facility Scheduled Scheduled for a future date Facility Rescheduled Facility rescheduled the appointment Late Has not been checked in and past the configured time by the facility No Show Has not been checked into past the configured days by the facility Checked In Checked in Unloaded Unloading has been completed Unloading Unloading in progress Loaded Loading has been completed Loading Loading in progress Checked Out Checked out Cancelled Cancelled values- Scheduled
- Checked
Out - Unloaded
- Loaded
- Unloading
- typeType: stringenumrequiredvalues
- Inbound
- Outbound
- updatedType: stringFormat: date-time
_at read-onlyrequiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- allType: array object[]
_load _types - idType: stringFormat: uuid
- nameType: string
- cancelledType: string | nullFormat: date-time
_at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- cancelledType: string | null
_note - cancelledType: string | nullenum
_reason values- F
A C I L I T Y _ R E J E C T E D _ L O A D - F
A C I L I T Y _ D E N I E D _ R E Q U E S T - F
A C I L I T Y _ C A N C E L L E D _ A P P O I N T M E N T - C
A R R I E R _ C A N C E L L E D _ A P P O I N T M E N T - A
U T O _ C A N C E L - null
- carrierType: string | null
- carrierType: string | null
_driver - carrierType: string | null
_email - carrierType: string | null
_notes - carrierType: string | null
_phone - checkedType: string | nullFormat: date-time
_in _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- checkedType: string | nullFormat: date-time
_out _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- dockType: string | null
- estimatedType: string | nullFormat: date-time
_start _datetime the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- forkliftType: string | null
- loadType: string | nullFormat: date-time
_finished _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- loadType: string | nullFormat: date-time
_started _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- loadingType: string | nullenum
_type values- Live
- Drop
- notesType: string
Notes created by facility staff and only visible to facility staff
- publicType: string
_notes Notes created by facility staff and visible to external parties that can view appointment (booker, etc)
- quantityType: integer | nullmin:1max:2147483647
Integer numbers.
- sealType: string | null
_number - shipperType: string | null
_receiver - trailerType: string | null
_number - unitsType: string | null
