Jump to

• Request
• Response

Get a Continuous Move Rule

get

/rateOfferings/{rateOfferingGid}/continuousMoveRules/{xLaneGid}

Request

Path Parameters

• rateOfferingGid(required): string
  Resource ID
• xLaneGid(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 : rateOfferings.continuousMoveRules

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• freeEmptyDistance: freeEmptyDistance
  The free distance allowed between shipments in a continuous move tour.
• links: array links
  Read Only: true
• maxConnectionTime: maxConnectionTime
  The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment
• maxEmptyDistance: maxEmptyDistance
  The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.
• maxRelEmptyDistance: number (double)
  Max Empty Distance (%) is used to disqualify shipments that are too short in comparison to the distance travelled to include the shipment in the continuous move tour.
  Max Empty Distance (%) = 100*E/L, where
  E = Max Empty Distance
  L = Line Haul Distance of the shipment
• maxTimeAfterDeliv: maxTimeAfterDeliv
  The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.
• minLinehaulDistance: minLinehaulDistance
  Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.
• xLaneGid: string
  The GID for the X Lane.

{
    "properties":{
        "xLaneGid":{
            "description":"The GID for the X Lane.",
            "type":"string"
        },
        "maxConnectionTime":{
            "description":"The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxEmptyDistance":{
            "description":"The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxRelEmptyDistance":{
            "description":"Max Empty Distance (%) is used to disqualify shipments that are too short in comparison to the distance travelled to include the shipment in the continuous move tour.<br>Max Empty Distance (%) = 100*E/L, where<br>E = Max Empty Distance<br>L = Line Haul Distance of the shipment",
            "type":"number",
            "format":"double"
        },
        "minLinehaulDistance":{
            "description":"Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxTimeAfterDeliv":{
            "description":"The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freeEmptyDistance":{
            "description":"The free distance allowed between shipments in a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : freeEmptyDistance

The free distance allowed between shipments in a continuous move tour.

Match All

Show Source

• object amountType

{
    "description":"The free distance allowed between shipments in a continuous move tour.",
    "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 : maxConnectionTime

The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment

Match All

Show Source

• object amountType

{
    "description":"The Max Connection Time field defines the maximum time allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The connection time of any pair of consecutive shipments in a continuous move cannot exceed the max connection time. Connection time is defined as the time between the end of the first shipment being considered and the start of the second shipment",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxEmptyDistance

The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.

Match All

Show Source

• object amountType

{
    "description":"The Max Empty Distance field defines the maximum empty distance that is allowed when planning any pair of consecutive shipments for inclusion in a continuous move tour. The maximum empty distance provides a way to limit the distance travelled to link shipments into a continuous move tour. If this field is not populated, shipments will be qualified for the same continuous move tour regardless of the distance required to connect them.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxTimeAfterDeliv

The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.

Match All

Show Source

• object amountType

{
    "description":"The maximum amount of time allowed between the last delivery of one shipment to the pickup of the next shipment. To create a continuous move, the second shipment must be picked up within a certain amount of time after the delivery of the preceding shipment. If this field is left blank, there is no time limit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minLinehaulDistance

Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.

Match All

Show Source

• object amountType

{
    "description":"Shipments that are less than the minimum linehaul distance will not be considered for continuous moves/continuous move rates.",
    "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