Get Appointments
get
/appointments
Request
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.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : appointments
Type:
Show Source
object
-
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
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : appointments.remarks
Type:
Show Source
object
-
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.