REST Enabled Action - Modify Dock Appointment

This feature extends the set of REST Service enabled Actions provided previously.  For this update, the Modify Dock Appointment has been added.

The initial set of REST Service Enabled Actions focus on supporting the evaluation of options and the setting of Dock Appointments by external applications.  The Dock Appointment REST enable Actions are provided to support the requirements of the Scheduling Standards Consortium (SSC) which was formed to simplify the integration of systems between shippers, carriers and intermediaries with the goal of creating a more efficient appointment scheduling process.

The provided REST enabled Actions include the following:

  • Modify Dock Appointment (new)
  • Appointment Options
  • Schedule An Appointment 
  • Remove Appointment

You can use these REST Enabled actions to:

  1. Request the available appointment options using the Appointment Options Request
  1. Review and select from options provided in the Appointment Options Response and then Schedule An Appointment using the information provided in the Appointment Options Response
  1. Remove a scheduled appointment with Remove Appointment -  to either simply remove the appointment, or as the first step in the process of modifying the appointment by removing the appointment and then re-running Appointment Options and  the Schedule An Appointment APIs.
  1. Modify a previously set appointment.

Modify Appointment Request

Table Summary:REST enabled action, modify appointment request.

Name Description Optional Comments
objectType object type - SHIPMENT   Default value is SHIPMENT

appointmentGid

Appointment ID that should be modified

 Yes

Pass either only Appointment ID or a valid combination of the other parameters

shipmentGid

 Shipment Id Yes Must include either Shipment Gid or/Value
shipRefnumQualGid Shipment Reference number Qualifier Gid Yes but mandatory when refnum value is provided Must include either objectGid or shipRefnumQual/Value
shipRefnumValue Shipment Reference number Value Yes but mandatory when qualifier is provided

Must include either objectGid or shipRefnumQual/Value
stopNumber stop number of a location for which appointment will be booked Yes

Must include either stopNumber or locationGid.
locationGid location of a shipment for which appointment will be booked Yes

appointmentStartTime

 appointment start time Yes Format should be yyyy-MM-DD HH:mm:ss

appointmentEndTime

 appointment end time Yes Format should be yyyy-MM-DD HH:mm:ss

locationResourceGid

 location resource gid for primary resource type Yes

Door at which user want to book an appointment.

If left blank then same door will be used for new appointment.

Response

Table Summary:REST enabled action, modify appointment response.

Name Type
Appointment Gid String
Confirmation Number String
Pickup Appointment Date Time Stamp
Delivery Appointment Date Time Stamp
Appointment start time Date Time Stamp
Appointment end time Date Time Stamp
Appointment Duration Duration (in secs)
Resource Type Gid String
Location Resource Name String
Location Resource Gid String
Stop Number String
IsSuccess Boolean
statusMessage String

This feature extends the Dock Appointment scheduling capabilities to external solutions allowing for a more collaborative and holistic appointment setting community model to exist. The provided functionality is designed to support the requirements of the Scheduling Standards Consortium (SSC) which was formed to simplify the integration of systems across the fragmented ecosystem between shippers, carriers and intermediaries and create a more efficient appointment scheduling process.

Steps to Enable

You don't need to do anything to enable this feature.

Tips And Considerations

REST Enabled Action API supports SHIPMENT object type only.

Key Resources