Jump to

• Request
• Response

Create a Stop

post

/trackingEvents/{iTransactionNo}/stops

Request

Path Parameters

• iTransactionNo(required): string
  Resource ID

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.stops"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.stops"
    }
}

Nested Schema : schema

Type: object

Show Source

• aeiIndicator: string
  The AEI indicator for the tracking event.
• domainName: string
  Database domain where this data is stored.
• erpc: string
  If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.
• eventCity: string
  The city associated with the tracking event.
• eventCountry: string
  The country associated with the tracking event.
• eventdate: eventdate
  The tracking event date.
• eventState: string
  The state associated with the tracking event.
• gatePierDoorNumber: string
  The gate pier door number assigned to the shipment tracking status.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• latitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• links: array links
  Read Only: true
• locationGid: string
  Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.
• locationIdValue: string
  The location reference value associated with the reference number qualifier.
• locationName: string
  A location name if supplied with the tracking event.
• locationRefnumQualGid: string
  The location reference number quantifier associated with a location reference number if supplied on the tracking event.
• longitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• portLocationFunctionCode: string
  The port location function code for ocean tracking events.
• referencePosition: string
  The position of this stop relative to the yet-to-be-created new stop.
• splcCode: string
  If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.
• stopSequence: number (int32)
  The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.
• stopType: string
  The stop type for the new stop created with tracking event.
• terminalName: string
  The terminal name for port associated with the tracking event status.
• timeZoneGid: string
  The time zone identifier for the tracking event.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "stopSequence":{
            "description":"The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.",
            "type":"number",
            "format":"int32"
        },
        "portLocationFunctionCode":{
            "description":"The port location function code for ocean tracking events.",
            "type":"string"
        },
        "locationRefnumQualGid":{
            "description":"The location reference number quantifier associated with a location reference number if supplied on the tracking event.",
            "type":"string"
        },
        "locationIdValue":{
            "description":"The location reference value associated with the reference number qualifier.",
            "type":"string"
        },
        "locationName":{
            "description":"A location name if supplied with the tracking event.",
            "type":"string"
        },
        "eventCity":{
            "description":"The city associated with the tracking event.",
            "type":"string"
        },
        "eventState":{
            "description":"The state associated with the tracking event.",
            "type":"string"
        },
        "eventCountry":{
            "description":"The country associated with the tracking event.",
            "type":"string"
        },
        "splcCode":{
            "description":"If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.",
            "type":"string"
        },
        "latitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "longitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "terminalName":{
            "description":"The terminal name for port associated with the tracking event status.",
            "type":"string"
        },
        "gatePierDoorNumber":{
            "description":"The gate pier door number assigned to the shipment tracking status.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone identifier for the tracking event.",
            "type":"string"
        },
        "eventdate":{
            "description":"The tracking event date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "aeiIndicator":{
            "description":"The AEI indicator for the tracking event.",
            "type":"string"
        },
        "referencePosition":{
            "description":"The position of this stop relative to the yet-to-be-created new stop.",
            "type":"string"
        },
        "stopType":{
            "description":"The stop type for the new stop created with tracking event.",
            "type":"string"
        },
        "locationGid":{
            "description":"Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "erpc":{
            "description":"If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventdate

The tracking event date.

Match All

Show Source

• object dateTimeType

{
    "description":"The tracking event date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• aeiIndicator: string
  The AEI indicator for the tracking event.
• domainName: string
  Database domain where this data is stored.
• erpc: string
  If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.
• eventCity: string
  The city associated with the tracking event.
• eventCountry: string
  The country associated with the tracking event.
• eventdate: eventdate
  The tracking event date.
• eventState: string
  The state associated with the tracking event.
• gatePierDoorNumber: string
  The gate pier door number assigned to the shipment tracking status.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• latitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• links: array links
  Read Only: true
• locationGid: string
  Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.
• locationIdValue: string
  The location reference value associated with the reference number qualifier.
• locationName: string
  A location name if supplied with the tracking event.
• locationRefnumQualGid: string
  The location reference number quantifier associated with a location reference number if supplied on the tracking event.
• longitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• portLocationFunctionCode: string
  The port location function code for ocean tracking events.
• referencePosition: string
  The position of this stop relative to the yet-to-be-created new stop.
• splcCode: string
  If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.
• stopSequence: number (int32)
  The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.
• stopType: string
  The stop type for the new stop created with tracking event.
• terminalName: string
  The terminal name for port associated with the tracking event status.
• timeZoneGid: string
  The time zone identifier for the tracking event.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "stopSequence":{
            "description":"The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.",
            "type":"number",
            "format":"int32"
        },
        "portLocationFunctionCode":{
            "description":"The port location function code for ocean tracking events.",
            "type":"string"
        },
        "locationRefnumQualGid":{
            "description":"The location reference number quantifier associated with a location reference number if supplied on the tracking event.",
            "type":"string"
        },
        "locationIdValue":{
            "description":"The location reference value associated with the reference number qualifier.",
            "type":"string"
        },
        "locationName":{
            "description":"A location name if supplied with the tracking event.",
            "type":"string"
        },
        "eventCity":{
            "description":"The city associated with the tracking event.",
            "type":"string"
        },
        "eventState":{
            "description":"The state associated with the tracking event.",
            "type":"string"
        },
        "eventCountry":{
            "description":"The country associated with the tracking event.",
            "type":"string"
        },
        "splcCode":{
            "description":"If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.",
            "type":"string"
        },
        "latitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "longitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "terminalName":{
            "description":"The terminal name for port associated with the tracking event status.",
            "type":"string"
        },
        "gatePierDoorNumber":{
            "description":"The gate pier door number assigned to the shipment tracking status.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone identifier for the tracking event.",
            "type":"string"
        },
        "eventdate":{
            "description":"The tracking event date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "aeiIndicator":{
            "description":"The AEI indicator for the tracking event.",
            "type":"string"
        },
        "referencePosition":{
            "description":"The position of this stop relative to the yet-to-be-created new stop.",
            "type":"string"
        },
        "stopType":{
            "description":"The stop type for the new stop created with tracking event.",
            "type":"string"
        },
        "locationGid":{
            "description":"Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "erpc":{
            "description":"If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventdate

The tracking event date.

Match All

Show Source

• object dateTimeType

{
    "description":"The tracking event date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• aeiIndicator: string
  The AEI indicator for the tracking event.
• domainName: string
  Database domain where this data is stored.
• erpc: string
  If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.
• eventCity: string
  The city associated with the tracking event.
• eventCountry: string
  The country associated with the tracking event.
• eventdate: eventdate
  The tracking event date.
• eventState: string
  The state associated with the tracking event.
• gatePierDoorNumber: string
  The gate pier door number assigned to the shipment tracking status.
• iRecNo: number (int64)
  The record number primary key identifier for the tracking event specified.
• latitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• links: array links
  Read Only: true
• locationGid: string
  Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.
• locationIdValue: string
  The location reference value associated with the reference number qualifier.
• locationName: string
  A location name if supplied with the tracking event.
• locationRefnumQualGid: string
  The location reference number quantifier associated with a location reference number if supplied on the tracking event.
• longitude: string
  A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
• portLocationFunctionCode: string
  The port location function code for ocean tracking events.
• referencePosition: string
  The position of this stop relative to the yet-to-be-created new stop.
• splcCode: string
  If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.
• stopSequence: number (int32)
  The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.
• stopType: string
  The stop type for the new stop created with tracking event.
• terminalName: string
  The terminal name for port associated with the tracking event status.
• timeZoneGid: string
  The time zone identifier for the tracking event.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "stopSequence":{
            "description":"The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.",
            "type":"number",
            "format":"int32"
        },
        "portLocationFunctionCode":{
            "description":"The port location function code for ocean tracking events.",
            "type":"string"
        },
        "locationRefnumQualGid":{
            "description":"The location reference number quantifier associated with a location reference number if supplied on the tracking event.",
            "type":"string"
        },
        "locationIdValue":{
            "description":"The location reference value associated with the reference number qualifier.",
            "type":"string"
        },
        "locationName":{
            "description":"A location name if supplied with the tracking event.",
            "type":"string"
        },
        "eventCity":{
            "description":"The city associated with the tracking event.",
            "type":"string"
        },
        "eventState":{
            "description":"The state associated with the tracking event.",
            "type":"string"
        },
        "eventCountry":{
            "description":"The country associated with the tracking event.",
            "type":"string"
        },
        "splcCode":{
            "description":"If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.",
            "type":"string"
        },
        "latitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "longitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "terminalName":{
            "description":"The terminal name for port associated with the tracking event status.",
            "type":"string"
        },
        "gatePierDoorNumber":{
            "description":"The gate pier door number assigned to the shipment tracking status.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone identifier for the tracking event.",
            "type":"string"
        },
        "eventdate":{
            "description":"The tracking event date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "aeiIndicator":{
            "description":"The AEI indicator for the tracking event.",
            "type":"string"
        },
        "referencePosition":{
            "description":"The position of this stop relative to the yet-to-be-created new stop.",
            "type":"string"
        },
        "stopType":{
            "description":"The stop type for the new stop created with tracking event.",
            "type":"string"
        },
        "locationGid":{
            "description":"Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "erpc":{
            "description":"If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventdate

The tracking event date.

Match All

Show Source

• object dateTimeType

{
    "description":"The tracking event date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top