Jump to

• Request
• Response

Fetch the list of denomination details

get

/service/v1/getCCYDenominationDetails

This API fetches list of denomination details based on given currency.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• branch: string
  Branch Value
• currency(optional): string
  Currency Value
• limit(optional): integer
  Limit To Be Fetched
• offset(optional): integer
  Offset Of Limit

Header Parameters

• appId: string
  Application Id
• authToken(optional): string
  Authorization Token
• branchCode: string
  Branch Code
• contentType(optional): string
  Content Type
• tenantId(optional): string
  Tenant Id
• userId: string
  UserId For SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : DenominationResponseModel

Type: object

Collection of Master and Denomination Details

Show Source

• denominationData(optional): array denominationData
  List Of Master and Denomination data
• errors(optional): object errors
  List Of Errors
• paging(optional): object PagingDto
• responseStatus(optional): string
  Response Status

{
    "description":"Collection of Master and Denomination Details",
    "type":"object",
    "properties":{
        "denominationData":{
            "type":"array",
            "description":"List Of Master and Denomination data",
            "items":{
                "$ref":"#/definitions/ObcmTmCashDenomMaintMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "errors":{
            "type":"object",
            "description":"List Of Errors ",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "responseStatus":{
            "type":"string",
            "description":"Response Status"
        }
    }
}

Nested Schema : denominationData

Type: array

List Of Master and Denomination data

Show Source

• Array of: object ObcmTmCashDenomMaintMasterDTO
  Cash Denomination Maint Master Model

{
    "type":"array",
    "description":"List Of Master and Denomination data",
    "items":{
        "$ref":"#/definitions/ObcmTmCashDenomMaintMasterDTO"
    }
}

Nested Schema : errors

Type: object

List Of Errors

Show Source

• Array of: object Error
  Error Model

{
    "type":"object",
    "description":"List Of Errors ",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : ObcmTmCashDenomMaintMasterDTO

Type: object

Cash Denomination Maint Master Model

Show Source

• authStat(optional): string
  Authorization Status
• branch(optional): string
  Branch Value
• checkerDtStamp(optional): string
  Checker Date
• checkerId(optional): string
  Checker ID
• currency(optional): string
  Currency
• id(optional): string
  Master Id
• mainUnit(optional): string
  Main Unit
• makerDtStamp(optional): string
  Maker Date
• makerId(optional): string
  Maker Id
• modNo(optional): integer
  Mod No
• ObcmTmCashDenomMaintDetailsDTO(optional): array ObcmTmCashDenomMaintDetailsDTO
• onceAuth(optional): string
  Once Authorization
• recordStat(optional): string
  Record Status
• subUnit(optional): string
  Sub Unit

{
    "type":"object",
    "description":"Cash Denomination Maint Master Model",
    "properties":{
        "id":{
            "type":"string",
            "description":"Master Id"
        },
        "branch":{
            "type":"string",
            "description":"Branch Value"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "mainUnit":{
            "type":"string",
            "description":"Main Unit"
        },
        "subUnit":{
            "type":"string",
            "description":"Sub Unit"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod No"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Maker Date"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"Checker Date"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Authorization"
        },
        "recordStat":{
            "type":"string",
            "description":"Record Status"
        },
        "authStat":{
            "type":"string",
            "description":"Authorization Status"
        },
        "ObcmTmCashDenomMaintDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmCashDenomMaintDetailsDTO"
            }
        }
    }
}

Nested Schema : ObcmTmCashDenomMaintDetailsDTO

Type: array

Show Source

• Array of: object ObcmTmCashDenomMaintDetailsDTO
  Cash Denomination Detail Model

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

Nested Schema : ObcmTmCashDenomMaintDetailsDTO

Type: object

Cash Denomination Detail Model

Show Source

• cashDenomMaintMasterId(optional): string
  Denomination Maint Master Id
• denominationDesc(optional): string
  Denomination Description
• denominationType(optional): string
  Denomination Type
• denominationValue(optional): string
  Denomination Value
• id(optional): string
  Denomination Id

{
    "type":"object",
    "description":"Cash Denomination Detail Model",
    "properties":{
        "denominationDesc":{
            "type":"string",
            "description":"Denomination Description"
        },
        "denominationType":{
            "type":"string",
            "description":"Denomination Type"
        },
        "denominationValue":{
            "type":"string",
            "description":"Denomination Value"
        },
        "id":{
            "type":"string",
            "description":"Denomination Id"
        },
        "cashDenomMaintMasterId":{
            "type":"string",
            "description":"Denomination Maint Master Id"
        }
    }
}

Nested Schema : Error

Type: object

Error Model

Show Source

• errorCode(optional): string
  Error Code
• errorDescription(optional): string
  Error Description
• errorStatus(optional): string
  Error Status

{
    "type":"object",
    "description":"Error Model",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Error Description"
        },
        "errorStatus":{
            "type":"string",
            "description":"Error Status"
        }
    }
}

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