Jump to

• Request
• Response

Get a Rules and Term

get

/rateOfferings/{rateOfferingGid}/rateRulesAndTerms/{ruleNumber}

Request

Path Parameters

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

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• ruleDesc: string
  Provides a place to store the description of the rule. For example, "Freight that is undeliverable due to error or omission on the part of the shipper, consignee, or owner or for which no disposition instructions have been provided shall be considered unclaimed/abandoned."
• ruleNumber: string
  Rules and Terms is used to store information about the rate offering. The rule number or rule/term identifies the rule being defined. For example, "Rule 921".
• ruleTitle: string
  Rule title provides a brief description of the rule being defined. For example, "UNCLAIMED/ABANDONED FREIGHT"

{
    "properties":{
        "ruleNumber":{
            "description":"Rules and Terms is used to store information about the rate offering. The rule number or rule/term identifies the rule being defined. For example, \"Rule 921\".",
            "type":"string"
        },
        "ruleTitle":{
            "description":"Rule title provides a brief description of the rule being defined. For example, \"UNCLAIMED/ABANDONED FREIGHT\" ",
            "type":"string"
        },
        "ruleDesc":{
            "description":"Provides a place to store the description of the rule. For example, \"Freight that is undeliverable due to error or omission on the part of the shipper, consignee, or owner or for which no disposition instructions have been provided shall be considered unclaimed/abandoned.\"",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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