Jump to

• Request
• Response

Get an Appointment

get

/appointments/{appointmentGid}

Request

Path Parameters

• appointmentGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : appointments

Type: object

Show Source

• appointmentActivityType: string
  Specifies if the trailer scheduled for the appointment is attached to the truck (Live) or being dropped (Drop). This field is for information purposes.
• appointmentEndTime: appointmentEndTime
  Appointment end time.
• appointmentGid: string
  The GID for the location resource appointment.
• appointmentStartTime: appointmentStartTime
  Appointment start time.
• appointmentXid: string
  The XID for the location resource appointment.
• confirmationNumber: string
  The appointment confirmation number.
• dataQueryTypeGid: string
  The GID of the data query type. Valid values in this column are SHIPMENT and SHIPMENT GROUP.
• domainName: string
  Domain where this data is stored.
• flexCommodityCode: string
  The user-defined commodity code for the shipment ship unit.
• infeasibleReason: string
  If the appointment is not feasible, this is the reason for it.
• insertDate: insertDate
  Read Only: true

  insert date
• isBlocked: boolean
  Indicates if the appointment time slot is blocked.
• isFeasible: boolean
  Indicates if the appointment is feasible.
• isFixed: boolean
  If the shipment has arrived at the stop, the appointment will be fixed.
• links: array links
  Read Only: true
• locationResourceGid: string
  The GID for the location resource.
• objectGid: string
  The GID for the shipment or shipment group object.
• remarks: remarks
• scheduleMethod: string
  Schedule methods are determined automatically based on how the appointment was scheduled.
  Automatic: The appointment is automatically scheduled via agent action.
  Manual: The appointment is scheduled via Dock Manager UI by a user.
  Integration: The appointment is scheduled via integration.
• sEquipmentGid: string
  The GID for the equipment associated with the shipment.
• stopNum: number (int32)
  The shipment stop number.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "appointmentGid":{
            "description":"The GID for the location resource appointment.",
            "type":"string"
        },
        "appointmentXid":{
            "description":"The XID for the location resource appointment.",
            "type":"string"
        },
        "locationResourceGid":{
            "description":"The GID for the location resource.",
            "type":"string"
        },
        "stopNum":{
            "description":"The shipment stop number.",
            "type":"number",
            "format":"int32"
        },
        "appointmentStartTime":{
            "description":"Appointment start time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentEndTime":{
            "description":"Appointment end time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFeasible":{
            "description":"Indicates if the appointment is feasible.",
            "type":"boolean"
        },
        "isFixed":{
            "description":"If the shipment has arrived at the stop, the appointment will be fixed.",
            "type":"boolean"
        },
        "isBlocked":{
            "description":"Indicates if the appointment time slot is blocked.",
            "type":"boolean"
        },
        "confirmationNumber":{
            "description":"The appointment confirmation number.",
            "type":"string"
        },
        "infeasibleReason":{
            "description":"If the appointment is not feasible, this is the reason for it.",
            "type":"string"
        },
        "dataQueryTypeGid":{
            "description":"The GID of the data query type. Valid values in this column are SHIPMENT and SHIPMENT GROUP.",
            "type":"string"
        },
        "objectGid":{
            "description":"The GID for the shipment or shipment group object.",
            "type":"string"
        },
        "appointmentActivityType":{
            "description":"Specifies if the trailer scheduled for the appointment is attached to the truck (Live) or being dropped (Drop). This field is for information purposes.",
            "type":"string"
        },
        "domainName":{
            "description":"Domain where this data is stored.",
            "type":"string"
        },
        "scheduleMethod":{
            "description":"Schedule methods are determined automatically based on how the appointment was scheduled. <br>Automatic: The appointment is automatically scheduled via agent action.<br>Manual: The appointment is scheduled via Dock Manager UI by a user.<br>Integration: The appointment is scheduled via integration.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The GID for the equipment associated with the shipment.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code for the shipment ship unit.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/appointments.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : appointmentEndTime

Appointment end time.

Match All

Appointment end time.

Show Source

• object dateTimeType

{
    "description":"Appointment end time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentStartTime

Appointment start time.

Match All

Appointment start time.

Show Source

• object dateTimeType

{
    "description":"Appointment start time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/appointments.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object appointments.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appointments.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : appointments.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID.
• remarkSequence: number (int64)
  The sequence number of a remark.
• remarkText: string
  The remark text.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number of a remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top