Jump to

• Request
• Response

Get the available appointments for a shipment

post

/custom-actions/getAvailableAppointments/shipments/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• appointmentEndTime: string
  Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format
• appointmentStartTime: string
  Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format
• locationGid: string
  Location ID - Shipment appointment location must be specified using either a Stop Number OR a Stop Location ID
• locationResourceTypeGid: string
  Location Resource Type Gid - Filter the appointment options based on the location resource type
• numberOfOptions: integer
  Number of appointment options requested - maximum is 50
• shipmentGid: string
  Shipment ID - Shipment must be identified using one of Shipment ID OR Shipment Reference Number
• shipmentRefnumQualGid: string
  Shipment Reference Number Qualifier ID - In the absence of a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.
• shipmentRefnumValue: string
  Shipment Reference Number - In the absence of a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.
• showOptionsForFirstAvailSlotOnly: boolean
  When set to true, the action will return appointment options for all resources from the next available slot. If set to false, the action will return appointment options for all resources from all time slots.
• stopNumber: integer
  Stop Number - Shipment appointment location must be specified using one of Stop Number OR Stop Location ID

{
    "type":"object",
    "properties":{
        "shipmentGid":{
            "description":"Shipment ID - Shipment must be identified using one of Shipment ID OR Shipment Reference Number",
            "type":"string"
        },
        "shipmentRefnumQualGid":{
            "description":"Shipment Reference Number Qualifier ID - In the absence of a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"Shipment Reference Number - In the absence of a Shipment ID, a shipment can be identified using a combination of a Shipment Reference Qualifier ID AND Shipment Reference Number.",
            "type":"string"
        },
        "stopNumber":{
            "description":"Stop Number - Shipment appointment location must be specified using one of Stop Number OR Stop Location ID",
            "type":"integer"
        },
        "locationGid":{
            "description":"Location ID  - Shipment appointment location must be specified using either a Stop Number OR a Stop Location ID",
            "type":"string"
        },
        "appointmentStartTime":{
            "description":"Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format",
            "type":"string"
        },
        "appointmentEndTime":{
            "description":"Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format",
            "type":"string"
        },
        "numberOfOptions":{
            "description":"Number of appointment options requested - maximum is 50",
            "type":"integer"
        },
        "showOptionsForFirstAvailSlotOnly":{
            "description":"When set to true, the action will return appointment options for all resources from the next available slot. If set to false, the action will return appointment options for all resources from all time slots.",
            "type":"boolean"
        },
        "locationResourceTypeGid":{
            "description":"Location Resource Type Gid - Filter the appointment options based on the location resource type",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success! A successful POST method returns a 200 status code.

Body ()

Root Schema : availableAppointmentOptionsResponse

Type: object

Available Appointment Options

Show Source

• appointmentOptions: array appointmentOptions
  List of available appointment options
• numberOfOptions: integer
  Number of appointment options in response
• responseStatus: object responseStatus

{
    "description":"Available Appointment Options",
    "type":"object",
    "properties":{
        "numberOfOptions":{
            "description":"Number of appointment options in response",
            "type":"integer"
        },
        "responseStatus":{
            "type":"object",
            "properties":{
                "isSuccess":{
                    "description":"Specifies if the action was successful",
                    "type":"boolean"
                },
                "statusMessage":{
                    "description":"Error message if action was unsuccessful",
                    "type":"string"
                }
            }
        },
        "appointmentOptions":{
            "description":"List of available appointment options",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/appointmentOption"
            }
        }
    }
}

Nested Schema : appointmentOptions

Type: array

List of available appointment options

Show Source

• Array of: object appointmentOption
  Available Appointment Option Details

{
    "description":"List of available appointment options",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appointmentOption"
    }
}

Nested Schema : responseStatus

Type: object

Show Source

• isSuccess: boolean
  Specifies if the action was successful
• statusMessage: string
  Error message if action was unsuccessful

{
    "type":"object",
    "properties":{
        "isSuccess":{
            "description":"Specifies if the action was successful",
            "type":"boolean"
        },
        "statusMessage":{
            "description":"Error message if action was unsuccessful",
            "type":"string"
        }
    }
}

Nested Schema : appointmentOption

Type: object

Available Appointment Option Details

Show Source

• appointmentEndTime: string
  Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format
• appointmentStartTime: string
  Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format
• infeasiblityCodes: array infeasiblityCodes
  List of Infeasiblity Codes when appointment is not feasible
• isAppointmentFeasible: boolean
  Is Appointment Feasible
• locationResourceGroup: string
  Location Resource Group
• locationResourceName: string
  Location Resource Name
• locationResourceTypeGid: string
  Location Resource Type Gid for each appointment option
• preferenceLevel: integer
  Preference Level

{
    "description":"Available Appointment Option Details",
    "type":"object",
    "properties":{
        "appointmentStartTime":{
            "description":"Appointment Start Time at the stop in yyyy-MM-dd HH:mm:ss format",
            "type":"string"
        },
        "appointmentEndTime":{
            "description":"Appointment End Time at the stop in yyyy-MM-dd HH:mm:ss format",
            "type":"string"
        },
        "isAppointmentFeasible":{
            "description":"Is Appointment Feasible",
            "type":"boolean"
        },
        "preferenceLevel":{
            "description":"Preference Level",
            "type":"integer"
        },
        "locationResourceName":{
            "description":"Location Resource Name",
            "type":"string"
        },
        "locationResourceGroup":{
            "description":"Location Resource Group",
            "type":"string"
        },
        "infeasiblityCodes":{
            "description":"List of Infeasiblity Codes when appointment is not feasible",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/infeasibleCode"
            }
        },
        "locationResourceTypeGid":{
            "description":"Location Resource Type Gid for each appointment option",
            "type":"string"
        }
    }
}

Nested Schema : infeasiblityCodes

Type: array

List of Infeasiblity Codes when appointment is not feasible

Show Source

• Array of: string
  Describes why appointment is infeasible

{
    "description":"List of Infeasiblity Codes when appointment is not feasible",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/infeasibleCode"
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized, the request was not successful because it lacks valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top