Rest API for Oracle Banking Cash Management

Fetch the list of location clusters

get

/service/v1/locationCluster

This API fetches list of location clusters based on given parameters

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat: string

Auth Status need to be set to fetch summary record
includecloseandunauth: boolean

Includecloseandunauth need to be set to fetch summary record, defult value is false
limit: integer

limit is maximum no of records to be fetched
locationClusterCode: string

Location Cluster Code
locationClusterDescription: string

Location Cluster Description
offset: integer

offset is starting no of records to be fetched
recordStat: string

Record Status need to be set to fetch summary record

Header Parameters

appId(required): string

Application Id
branchCode(required): string

Branch Code
userId(required): string

User Id

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created location cluster

Root Schema : CmTmLocationClusterMasterCollection

Type: object

Collection of cmtmlocationclustermaster.

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object CmTmLocationClusterMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : CmTmLocationClusterMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object CmTmLocationClusterMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "required":[
                "clearingDays",
                "locationClusterCode",
                "locationClusterDescription"
            ],
            "properties":{
                "id":{
                    "type":"string",
                    "description":""
                },
                "action":{
                    "type":"string",
                    "description":""
                },
                "autoAuth":{
                    "type":"string",
                    "description":""
                },
                "modificationStatus":{
                    "type":"string",
                    "description":""
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":""
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":""
                },
                "makerRemarks":{
                    "type":"string",
                    "description":""
                },
                "clearingDays":{
                    "type":"number",
                    "description":"",
                    "minimum":"1",
                    "maximum":"99"
                },
                "locationClusterCode":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Za-z0-9-_]{1,15}",
                    "x-pattern-message":"CM-LOCC-002"
                },
                "locationClusterDescription":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Za-z0-9-_ ]{1,50}",
                    "x-pattern-message":"CM-LOCC-003"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]
Generic Response.

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "description":"Generic Response.",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Nested Schema : CmTmLocationClusterMasterDTO-allOf[1]

Type: object

Show Source

action: string
autoAuth: string
checkerRemarks: string
clearingDays(required): number

Minimum Value: 1

Maximum Value: 99
datasegmentCode: string
id: string
locationClusterCode(required): string

Pattern: [A-Za-z0-9-_]{1,15}
locationClusterDescription(required): string

Pattern: [A-Za-z0-9-_ ]{1,50}
makerRemarks: string
modificationStatus: string

{
    "type":"object",
    "required":[
        "clearingDays",
        "locationClusterCode",
        "locationClusterDescription"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "action":{
            "type":"string",
            "description":""
        },
        "autoAuth":{
            "type":"string",
            "description":""
        },
        "modificationStatus":{
            "type":"string",
            "description":""
        },
        "datasegmentCode":{
            "type":"string",
            "description":""
        },
        "checkerRemarks":{
            "type":"string",
            "description":""
        },
        "makerRemarks":{
            "type":"string",
            "description":""
        },
        "clearingDays":{
            "type":"number",
            "description":"",
            "minimum":"1",
            "maximum":"99"
        },
        "locationClusterCode":{
            "type":"string",
            "description":"",
            "pattern":"[A-Za-z0-9-_]{1,15}",
            "x-pattern-message":"CM-LOCC-002"
        },
        "locationClusterDescription":{
            "type":"string",
            "description":"",
            "pattern":"[A-Za-z0-9-_ ]{1,50}",
            "x-pattern-message":"CM-LOCC-003"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error