Jump to

• Request
• Response

Get a Location

get

/voyages/{voyageGid}/locations/{seqNo}

Request

Path Parameters

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

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

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

{
    "properties":{
        "seqNo":{
            "description":"The sequence number for the location of the voyage.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The GID for the location of the voyage.",
            "type":"string"
        },
        "dOrA":{
            "description":"Defines whether the location is a pickup (D) or delivery (A) point for the voyage.",
            "type":"string"
        },
        "dOrADate":{
            "description":"The date for the pickup (D) or delivery (A) for the voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDOrADate":{
            "description":"The estimated date at port sometimes sent by a carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "actualDOrADate":{
            "description":"The actual date at port sometimes sent by carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataSourcePartitionKey":{
            "description":"Partition key used to parse the data based on the data source.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isTransload":{
            "description":"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.)",
            "type":"boolean"
        },
        "voyageServiceTypeGid":{
            "description":"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.",
            "type":"string"
        },
        "voyageDescription":{
            "description":"The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.",
            "type":"string"
        },
        "vesselDescription":{
            "description":"The Vessel Description field is for further information about the vessel for the leg. It is for information only.",
            "type":"string"
        },
        "isMotherVessel":{
            "description":"You can select the Mother check box to indicate that this is the mother vessel or \"vessel of record\" for the leg for customs.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDOrADate

The actual date at port sometimes sent by carrier.

Match All

The actual date at port sometimes sent by carrier.

Show Source

• object dateTimeType

{
    "description":"The actual date at port sometimes sent by carrier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dOrADate

The date for the pickup (D) or delivery (A) for the voyage.

Match All

The date for the pickup (D) or delivery (A) for the voyage.

Show Source

• object dateTimeType

{
    "description":"The date for the pickup (D) or delivery (A) for the voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : estimatedDOrADate

The estimated date at port sometimes sent by a carrier.

Match All

The estimated date at port sometimes sent by a carrier.

Show Source

• object dateTimeType

{
    "description":"The estimated date at port sometimes sent by a carrier.",
    "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