Jump to

• Request
• Response

Get Details

get

/lnmShipments/{shipmentGid}/stops/{stopNum}/details

Request

Path Parameters

• shipmentGid(required): string
  Resource ID
• stopNum(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 Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object lnmShipments.stops.details

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : lnmShipments.stops.details

Type: object

Show Source

• activity: string
  The activity performed at the stop. For example: Pickup, Delivery etc.
• activityTime: activityTime
  No description.
• bulkplanGid: string
  No description.
• bulkplanSpecGid: string
  No description.
• domainName: string
  No description.
• isPermanent: boolean
  No description.
• links: array links
  Read Only: true
• scenarioGid: string
  No description.
• shipUnitDwellTime: shipUnitDwellTime
  This field represents ship unit dwell time at the stop location as entered.
• sShipUnitGid: string
  A unique pointer to define the shipment ship unit. The gid contains the domain portion.

{
    "properties":{
        "sShipUnitGid":{
            "description":"A unique pointer to define the shipment ship unit. The gid contains the domain portion.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "scenarioGid":{
            "description":"No description.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop.   For example:  Pickup,  Delivery etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"No description.",
            "type":"boolean"
        },
        "shipUnitDwellTime":{
            "description":"This field represents ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bulkplanSpecGid":{
            "description":"No description.",
            "type":"string"
        },
        "bulkplanGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "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 : shipUnitDwellTime

This field represents ship unit dwell time at the stop location as entered.

Match All

This field represents ship unit dwell time at the stop location as entered.

Show Source

• object amountType

{
    "description":"This field represents ship unit dwell time at the stop location as entered.",
    "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"
        }
    }
}

Back to Top