Jump to

• Request
• Response

Retrieves the currency by given ID.

get

/api/1.0/service/lmm/currency/{id}/unauthorized

This endpoint is used to get the currency identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  Id of the user that needs to be fetched

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the currency based on given id.

Body ()

Root Schema : LmmTmCurrencyParametersCollection

Type: object

Collection of currencyparameters.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of currencyparameters.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmCurrencyParametersDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmCurrencyParametersDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmmTmCurrencyParametersDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmmTmCurrencyParametersDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmCurrencyParametersDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "currencyCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":"3"
                },
                "currencyName":{
                    "type":"string",
                    "description":"",
                    "maxLength":"105"
                },
                "ieBenefit":{
                    "type":"string",
                    "description":"",
                    "maxLength":"1",
                    "pattern":"[Y,N]"
                },
                "ieParticipation":{
                    "type":"string",
                    "description":"",
                    "maxLength":"1",
                    "pattern":"[Y,N]"
                }
            },
            "required":[
                "currencyCode",
                "currencyName"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmCurrencyParametersDTO-allOf[1]

Type: object

Show Source

• currencyCode(required): string
  Maximum Length: 3
• currencyName(required): string
  Maximum Length: 105
• ieBenefit: string
  Maximum Length: 1

  Pattern: [Y,N]
• ieParticipation: string
  Maximum Length: 1

  Pattern: [Y,N]

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string",
            "description":"",
            "maxLength":"3"
        },
        "currencyName":{
            "type":"string",
            "description":"",
            "maxLength":"105"
        },
        "ieBenefit":{
            "type":"string",
            "description":"",
            "maxLength":"1",
            "pattern":"[Y,N]"
        },
        "ieParticipation":{
            "type":"string",
            "description":"",
            "maxLength":"1",
            "pattern":"[Y,N]"
        }
    },
    "required":[
        "currencyCode",
        "currencyName"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top