Jump to

• Request
• Response

Get Currency Parameters

post

/config/sim/v1/setup/getcurrencyparameters

Gets all the currencies.

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : GetRequestBody

Type: object

The input Body model that needs to be given for get request.

Show Source

• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: integer
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given for get request.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Currency Parameter objects of the organization

Body ()

Root Schema : CurrencyParameter

Type: object

Model for Currency Parameter Object

Show Source

• altCurrObjName: object CurrencyNameTranslatedString
  A group of string objects representing the name of the currency in configured languages.
• altCurrObjNum: integer
  Object number of the alternate currency.

  Example: 31
• baseCurrObjName: object CurrencyNameTranslatedString
  A group of string objects representing the name of the currency in configured languages.
• baseCurrObjNum(required): integer
  Object number of the currency.

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the print class is configured

  Example: 3599
• hierUnitName: object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum: integer
  Object number of the hierarchy unit where the print class is configured

  Example: 26
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameter

  Example: 11010101
• optionsExt: object CurrencyParameterOptionsExt
  An object containing the descriptive options list associated with the currency parameter.

{
    "description":"Model for Currency Parameter Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "baseCurrObjNum"
    ],
    "properties":{
        "baseCurrObjNum":{
            "description":"Object number of the currency.",
            "type":"integer",
            "example":1
        },
        "baseCurrObjName":{
            "$ref":"#/definitions/CurrencyNameTranslatedString"
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the print class is configured",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the print class is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "altCurrObjNum":{
            "description":"Object number of the alternate currency.",
            "type":"integer",
            "example":31
        },
        "altCurrObjName":{
            "$ref":"#/definitions/CurrencyNameTranslatedString"
        },
        "options":{
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameter",
            "type":"string",
            "example":"11010101"
        },
        "optionsExt":{
            "$ref":"#/definitions/CurrencyParameterOptionsExt"
        }
    }
}

Nested Schema : CurrencyNameTranslatedString

Type: object

A group of string objects representing the name of the currency in configured languages.

Example:

{
    "en-US":"USD Dollar",
    "de-DE":"USD-Dollar"
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}

Nested Schema : CurrencyParameterOptionsExt

Type: object

An object containing the descriptive options list associated with the currency parameter.

Example:

{
    "roundCurrency":false,
    "roundToNearestZero":false,
    "roundToSecondLeastSignDigit":false
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top