Jump to

• Request
• Response

Get Currency Definitions

get

/services/private/Common/Currencies

This service is used to get currency definitions.

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Currencies

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

Nested Schema : Currencies

Type: object

Show Source

• currencyCode: string
• currencyCostDecimal: integer (int32)
• currencyCostFormat: string
• currencyDescription: string
• currencyRetailDecimal: integer (int32)
• currencyRetailFormat: string
• hyperMediaContent: object hyperMediaContent
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "currencyCode":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        },
        "currencyCostDecimal":{
            "type":"integer",
            "format":"int32"
        },
        "currencyCostFormat":{
            "type":"string"
        },
        "currencyDescription":{
            "type":"string"
        },
        "currencyRetailDecimal":{
            "type":"integer",
            "format":"int32"
        },
        "currencyRetailFormat":{
            "type":"string"
        }
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

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

Back to Top