Jump to

• Request
• Response

Get a Cost

get

/damageClaims/{claimGid}/costs/{costSeqNo}

Request

Path Parameters

• claimGid(required): string
  Resource ID
• costSeqNo(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 : schema

Type: object

Show Source

• claimCostTypeGid: string
  Cost type of the claim cost. These values are a combination of PUBLIC types shippped with the system and types specified by the user. The cost type will indicate if this cost should be added or subtracted from the claim damage/loss value.
• cost: cost
  Value of the claim cost.
• costSeqNo: number (int64)
  Sequence number to keep costs unique.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• payeeContactGid: string
  The GID for the payee contact.
• payorContactGid: string
  The GID for the payor contact.

{
    "properties":{
        "costSeqNo":{
            "description":"Sequence number to keep costs unique.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"Value of the claim cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "claimCostTypeGid":{
            "description":"Cost type of the claim cost. These values are a combination of PUBLIC types shippped with the system and types specified by the user. The cost type will indicate if this cost should be added or subtracted from the claim damage/loss value.",
            "type":"string"
        },
        "payeeContactGid":{
            "description":"The GID for the payee contact.",
            "type":"string"
        },
        "payorContactGid":{
            "description":"The GID for the payor contact.",
            "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 : cost

Value of the claim cost.

Match All

Value of the claim cost.

Show Source

• object currencyType

{
    "description":"Value of the claim cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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 : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top