Jump to

• Request
• Response

Get a Special Service

get

/trackingEvents/{iTransactionNo}/specialServices/{iRecNo}

Request

Path Parameters

• iRecNo(required): string
  Resource ID
• 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.

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 : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier that is being reported against with the tracking event being reported.",
            "type":"string"
        },
        "serviceDuration":{
            "description":"The time duration that occurred for the special service on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "serviceTime":{
            "description":"The time for the special service activity on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "weight":{
            "description":"The weight for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distance":{
            "description":"The distance for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "itemCount":{
            "description":"The item piece count for the special service activity recorded on the tracking event for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "shipUnitCount":{
            "description":"The ship unit count for the special service activity recorded on the tracking event for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "serviceCompletionState":{
            "description":"An indication if the special service activity was completed with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distance

The distance for the special service activity recorded on the tracking event for the shipment.

Match All

The distance for the special service activity recorded on the tracking event for the shipment.

Show Source

• object amountType

{
    "description":"The distance for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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/trackingEvents.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : serviceDuration

The time duration that occurred for the special service on the tracking event.

Match All

The time duration that occurred for the special service on the tracking event.

Show Source

• object amountType

{
    "description":"The time duration that occurred for the special service on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : serviceTime

The time for the special service activity on the tracking event.

Match All

The time for the special service activity on the tracking event.

Show Source

• object dateTimeType

{
    "description":"The time for the special service activity on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : volume

The volume for the special service activity recorded on the tracking event for the shipment.

Match All

The volume for the special service activity recorded on the tracking event for the shipment.

Show Source

• object amountType

{
    "description":"The volume for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight for the special service activity recorded on the tracking event for the shipment.

Match All

The weight for the special service activity recorded on the tracking event for the shipment.

Show Source

• object amountType

{
    "description":"The weight for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

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 trackingEvents.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.specialServices.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 : trackingEvents.specialServices.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 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.

{
    "properties":{
        "remarkSequence":{
            "description":"A remark sequence number if entering multiple remarks for a shipment special service tracking event.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The shipment remark text value for the qualifier defined.",
            "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
}

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"
        }
    }
}

Back to Top