Get Special Services
get
/trackingEvents/{iTransactionNo}/specialServices
Request
Path Parameters
-
iTransactionNo(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 : trackingEvents.specialServices
Type:
Show Source
object
-
distance:
distance
The distance for the special service activity recorded on the tracking event for the shipment.
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
itemCount: number
(int64)
The item piece count for the special service activity recorded on the tracking event for the shipment.
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
serviceCompletionState: string
An indication if the special service activity was completed with the tracking event.
-
serviceDuration:
serviceDuration
The time duration that occurred for the special service on the tracking event.
-
serviceTime:
serviceTime
The time for the special service activity on the tracking event.
-
shipUnitCount: number
(int64)
The ship unit count for the special service activity recorded on the tracking event for the shipment.
-
specialServiceGid: string
The special service identifier that is being reported against with the tracking event being reported.
-
volume:
volume
The volume for the special service activity recorded on the tracking event for the shipment.
-
weight:
weight
The weight for the special service activity recorded on the tracking event for the shipment.
Nested Schema : distance
The distance for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : serviceDuration
The time duration that occurred for the special service on the tracking event.
Match All
Show Source
Nested Schema : serviceTime
The time for the special service activity on the tracking event.
Match All
Show Source
Nested Schema : volume
The volume for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : weight
The weight for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : trackingEvents.specialServices.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 identifier.
-
remarkSequence: number
(int64)
A remark sequence number if entering multiple remarks for a shipment special service tracking event.
-
remarkText: string
The shipment remark text value for the qualifier defined.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format