Jump to

• Request
• Response

Get SMC Discounts

get

/rateRecords/{rateGeoGid}/smcDiscounts

Request

Path Parameters

• rateGeoGid(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/rateRecords.smcDiscounts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateRecords.smcDiscounts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateRecords.smcDiscounts"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : rateRecords.smcDiscounts

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• l5cDiscount: number (double)
  Percent discount for weights <= 500 lb.< div>
• links: array links
  Read Only: true
• m10mDiscount: number (double)
  Percent discount for weight > 10,000 lb.
• m1mDiscount: number (double)
  Percent discount for weight > 1000 lb.
• m20mDiscount: number (double)
  Percent discount for weight > 20,000 lb.
• m2mDiscount: number (double)
  Percent discount for weight > 2000 lb.
• m30mDiscount: number (double)
  Percent discount for weight > 30,000 lb.
• m40mDiscount: number (double)
  Percent discount for weight > 40,000 lb.
• m5cDiscount: number (double)
  Percent discount for weight > 500 lb.
• m5mDiscount: number (double)
  Percent discount for weight > 5000 lb.
• minDiscount: number (double)
  Percent for minimum cost.
• movementType: string
  Qualifies the usage of the discounts defined by SMC/Carrier Connect Movement Type.
  If null, then the discounts provided (by weight break) apply to all Movement Types. Otherwise - the discounts defined apply to the specified Movement Type - either Direct, Indirect, Partner or Custom.
• rateOfferingGid: string
  The GID for the rate offering related to the SMC discount as table of values.
• smcDiscSeqNum: number (int64)
  An internal sequence number for the different SMC discount entries provided by movement type.
• stopAlternationBreak: string
  Specifies the weight break where the deficit rating should stop.

{
    "properties":{
        "smcDiscSeqNum":{
            "description":"An internal sequence number for the different SMC discount entries provided by movement type.",
            "type":"number",
            "format":"int64"
        },
        "rateOfferingGid":{
            "description":"The GID for the  rate offering related to the SMC discount as table of values.",
            "type":"string"
        },
        "minDiscount":{
            "description":"Percent for minimum cost.",
            "type":"number",
            "format":"double"
        },
        "l5cDiscount":{
            "description":"Percent discount for weights <= 500 lb.",
            "type":"number",
            "format":"double"
        },
        "m5cDiscount":{
            "description":"Percent discount for weight > 500 lb.",
            "type":"number",
            "format":"double"
        },
        "m1mDiscount":{
            "description":"Percent discount for weight > 1000 lb.",
            "type":"number",
            "format":"double"
        },
        "m2mDiscount":{
            "description":"Percent discount for weight > 2000 lb.",
            "type":"number",
            "format":"double"
        },
        "m5mDiscount":{
            "description":"Percent discount for weight > 5000 lb.",
            "type":"number",
            "format":"double"
        },
        "m10mDiscount":{
            "description":"Percent discount for weight > 10,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m20mDiscount":{
            "description":"Percent discount for weight > 20,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m30mDiscount":{
            "description":"Percent discount for weight > 30,000 lb.",
            "type":"number",
            "format":"double"
        },
        "m40mDiscount":{
            "description":"Percent discount for weight > 40,000 lb.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "stopAlternationBreak":{
            "description":"Specifies the weight break where the deficit rating should stop. ",
            "type":"string"
        },
        "movementType":{
            "description":"Qualifies the usage of the discounts defined by SMC/Carrier Connect Movement Type.<br>If null, then the discounts provided (by weight break) apply to all Movement Types.  Otherwise - the discounts defined apply to the specified Movement Type - either Direct, Indirect, Partner or Custom.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top