Get Operational Locations
get
/locations/{locationGid}/operationalLocations
Request
Path Parameters
-
locationGid(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 : locations.operationalLocations
Type:
Show Source
object
-
details:
details
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
operationalLocationGid: string
Sub location belonging to a main location. Sub location may only belong to one location.
Nested Schema : details
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.operationalLocations.details
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
exclusionRegionGid: string
If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.
-
inboundOutboundType: string
Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).
-
inclusionRegionGid: string
If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.
-
links: array
links
Read Only:
true
-
primaryLegLocProfileGid: string
The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.
-
primaryLegServprovGid: string
The service provider of the main leg which will help indicate which operational location applies.
-
seqNo: number
(int64)
Sequence to allow multiple data records for the same operational location.