Jump to

• Request
• Response

Get a Special Service

get

/rateRecords/{rateGeoGid}/specialServices/{specialServiceGid}

Request

Path Parameters

• rateGeoGid(required): string
  Resource ID
• specialServiceGid(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 : rateRecords.specialServices

Type: object

Show Source

• accessorials: accessorials
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateRecords.specialServices.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

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

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

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

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 : rateRecords.specialServices.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial code.
• accessorialCostGid: string
  The GID for the special service related accessorial cost. The accessorial code and cost are provided in situations where the special service is provided for a charge -which is defined by the related accessorial code and cost.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCostGid":{
            "description":"The GID for the special service related accessorial cost. The accessorial code and cost are provided in situations where the special service is provided for a charge -which is defined by the related accessorial code and cost.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code.",
            "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