Get Locations
get
/voyages/{voyageGid}/locations
Request
Path Parameters
-
voyageGid(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.
-
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 : voyages.locations
Type:
Show Source
object
-
actualDOrADate:
actualDOrADate
The actual date at port sometimes sent by carrier.
-
dataSourcePartitionKey: number
(double)
Partition key used to parse the data based on the data source.
-
domainName: string
Database domain where this data is stored.
-
dOrA: string
Defines whether the location is a pickup (D) or delivery (A) point for the voyage.
-
dOrADate:
dOrADate
The date for the pickup (D) or delivery (A) for the voyage.
-
estimatedDOrADate:
estimatedDOrADate
The estimated date at port sometimes sent by a carrier.
-
isMotherVessel: boolean
You can select the Mother check box to indicate that this is the mother vessel or "vessel of record" for the leg for customs.
-
isTransload: boolean
For composite voyages. The transload point check box identifies the transload port in the rotation. The Transload check box is used by OTM to indicate a transload stop (the stop type will be "T" for transload.)
-
links: array
links
Read Only:
true
-
locationGid: string
The GID for the location of the voyage.
-
seqNo: number
(int32)
The sequence number for the location of the voyage.
-
vesselDescription: string
The Vessel Description field is for further information about the vessel for the leg. It is for information only.
-
voyageDescription: string
The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.
-
voyageServiceTypeGid: string
The GID for the voyage service type. The Voyage Service Type ID field is the voyage service type of the operator of the leg. It is a validated field but is only used for information and documentation. The Voyage Service Type ID on the header is operational and used to link the voyage to the rate service. The voyage service type of the mother vessel should be the voyage service type on the header.
Nested Schema : actualDOrADate
The actual date at port sometimes sent by carrier.
Match All
Show Source
Nested Schema : dOrADate
The date for the pickup (D) or delivery (A) for the voyage.
Match All
Show Source
Nested Schema : estimatedDOrADate
The estimated date at port sometimes sent by a carrier.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format