Jump to

• Request
• Response

Get a Secondary Charge Rule

get

/secondaryChargeRules/{secondaryChargeRuleGid}

Request

Path Parameters

• secondaryChargeRuleGid(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 : secondaryChargeRules

Type: object

Show Source

• calculateShipUnitDuration: boolean
  No description.
• contactProfileGid: string
  No description.
• copiedRefnums: copiedRefnums
• criteriaRateGeoGid: string
  No description.
• criteriaRateOfferingGid: string
  No description.
• criteriaServprovGid: string
  No description.
• description: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  No description.
• expirationDate: expirationDate
  No description.
• flexCommodityProfileGid: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• involvedPartyQualGid: string
  No description.
• itineraryProfileGid: string
  No description.
• links: array links
  Read Only: true
• locationProfileGid: string
  No description.
• locationType: string
  No description.
• modeProfileGid: string
  No description.
• paymentMethodCodeGid: string
  No description.
• perspective: string
  No description.
• portOfDisLocProfileGid: string
  No description.
• portOfLoadLocProfileGid: string
  No description.
• quantityType: string
  No description.
• resLocationProfileId: string
  No description.
• routeCodeProfileGid: string
  No description.
• ruleContracts: ruleContracts
• ruleType: string
  No description.
• secondaryChargeRuleGid: string
  No description.
• secondaryChargeRuleXid: string
  No description.
• shipmentTypeGid: string
  No description.
• specialServiceProfileGid: string
  No description.
• transportModeGid: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• xLaneGid: string
  No description.

{
    "properties":{
        "secondaryChargeRuleGid":{
            "description":"No description.",
            "type":"string"
        },
        "secondaryChargeRuleXid":{
            "description":"No description.",
            "type":"string"
        },
        "specialServiceProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "locationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "description":{
            "description":"No description.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "xLaneGid":{
            "description":"No description.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "itineraryProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "ruleType":{
            "description":"No description.",
            "type":"string"
        },
        "routeCodeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "criteriaServprovGid":{
            "description":"No description.",
            "type":"string"
        },
        "portOfLoadLocProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "portOfDisLocProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "locationType":{
            "description":"No description.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "quantityType":{
            "description":"No description.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "resLocationProfileId":{
            "description":"No description.",
            "type":"string"
        },
        "criteriaRateOfferingGid":{
            "description":"No description.",
            "type":"string"
        },
        "involvedPartyQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "contactProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "calculateShipUnitDuration":{
            "description":"No description.",
            "type":"boolean"
        },
        "perspective":{
            "description":"No description.",
            "type":"string"
        },
        "criteriaRateGeoGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "copiedRefnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/secondaryChargeRules.copiedRefnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/secondaryChargeRules.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "ruleContracts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/secondaryChargeRules.ruleContracts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : copiedRefnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/secondaryChargeRules.copiedRefnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

No description.

Match All

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

No description.

Match All

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/secondaryChargeRules.involvedParties"
            }
        },
        "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 : ruleContracts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/secondaryChargeRules.ruleContracts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object secondaryChargeRules.copiedRefnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/secondaryChargeRules.copiedRefnums"
    }
}

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 : secondaryChargeRules.copiedRefnums

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• shipmentRefnumQualGid: string
  No description.

{
    "properties":{
        "shipmentRefnumQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object secondaryChargeRules.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/secondaryChargeRules.involvedParties"
    }
}

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 : secondaryChargeRules.involvedParties

Type: object

Show Source

• comMethodGid: string
  No description.
• domainName: string
  No description.
• involvedPartyContactGid: string
  No description.
• involvedPartyQualGid: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"No description.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 : items

Type: array

Show Source

• Array of: object secondaryChargeRules.ruleContracts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/secondaryChargeRules.ruleContracts"
    }
}

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 : secondaryChargeRules.ruleContracts

Type: object

Show Source

• accessorialCodeProfileGid: string
  No description.
• domainName: string
  No description.
• links: array links
  Read Only: true
• rateGeoGid: string
  No description.
• rateOfferingGid: string
  No description.
• scRuleContractSeqNo: number (int32)
  No description.
• servprovGid: string
  No description.
• specialServiceProfileGid: string
  No description.

{
    "properties":{
        "scRuleContractSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"No description.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"No description.",
            "type":"string"
        },
        "servprovGid":{
            "description":"No description.",
            "type":"string"
        },
        "specialServiceProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeProfileGid":{
            "description":"No description.",
            "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
}

Back to Top