Previous Next JavaScript must be enabled to correctly display this content

## Close the currency pairs by given ID

patch

/service/currencypairs/{currency1}/{currency2}/{maintenanceCountry}/close

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

### Request

Supported Media Types

- application/json
- application/xml

Path Parameters

- currency1: string
  key of the currencypairs Maintenance
- currency2: string
  key of the currencypairs Maintenance
- maintenanceCountry: string
  key of the currencypairs Maintenance

Header Parameters

- sourceCode: string
  Source from which request is initiated

Body ()
Request body contain currencypairs and Modification no of currencypairs maintenance which need to be closed"
Root Schema : CloseDto
Type: `object`
Show Source

- modNo(optional): integer
- remarks(optional): string

    {
        "type":"object",
        "properties":{
            "modNo":{
                "type":"integer"
            },
            "remarks":{
                "type":"string"
            }
        }
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Successful operation.
Body ()
Root Schema : CmcTmCurrencyPairDefnResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object CmcTmCurrencyPairDefnDto
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/CmcTmCurrencyPairDefnDto"
            }
        }
    }

Nested Schema : CmcTmCurrencyPairDefnDto
Type: `object`
Match All
Show Source

- allOf GenericDto
- object CmcTmCurrencyPairDefnDto-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "currency1":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "currency2":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "throughCurrency":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "quotation":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:D|I)$"
                    },
                    "noOfUnits":{
                        "type":"number",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:0|2|3)$"
                    },
                    "spreadDefn":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1,
                        "pattern":"^(?:%|,|.)$"
                    },
                    "pointsMultiplier":{
                        "type":"number"
                    },
                    "maintenanceCountry":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "checkThroughCurrency":{
                        "type":"string"
                    }
                },
                "required":[
                    "currency1",
                    "currency2",
                    "maintenanceCountry"
                ]
            }
        ]
    }

Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

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 : CmcTmCurrencyPairDefnDto-allOf[1]
Type: `object`
Show Source

- checkThroughCurrency(optional): string
- currency1: string
  Minimum Length: `0`
  Maximum Length: `3`
- currency2: string
  Minimum Length: `0`
  Maximum Length: `3`
- maintenanceCountry: string
  Minimum Length: `0`
  Maximum Length: `3`
- noOfUnits(optional): number
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:0|2|3)$`
- pointsMultiplier(optional): number
- quotation(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:D|I)$`
- spreadDefn(optional): string
  Minimum Length: `0`
  Maximum Length: `1`
  Pattern: `^(?:%|,|.)$`
- throughCurrency(optional): string
  Minimum Length: `0`
  Maximum Length: `3`

    {
        "type":"object",
        "properties":{
            "currency1":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "currency2":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "throughCurrency":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "quotation":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:D|I)$"
            },
            "noOfUnits":{
                "type":"number",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:0|2|3)$"
            },
            "spreadDefn":{
                "type":"string",
                "minLength":0,
                "maxLength":1,
                "pattern":"^(?:%|,|.)$"
            },
            "pointsMultiplier":{
                "type":"number"
            },
            "maintenanceCountry":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "checkThroughCurrency":{
                "type":"string"
            }
        },
        "required":[
            "currency1",
            "currency2",
            "maintenanceCountry"
        ]
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

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

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 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