Rest API for Oracle Banking Cash Management

Fetch the list of locations maintained

get

/service/v1/location

This API fetches list of locations maintained based on given parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat: string

authStatus 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
locationCode: string
locationDescription: string
offset: integer

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

recordStatus need to be set to fetch summary record

Header Parameters

appId(required): string

App ID
branchCode(required): string

branchCode
userId(required): string

userId

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Response 201

Root Schema : CmTmLocationLinkCollection

Type: object

Collection of Location Link.

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object CmTmLocationLinkDTO

CmTmLocationLink DTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : CmTmLocationLinkDTO

Type: object

CmTmLocationLink DTO

Match All

Show Source

allOf GenericDto
object CmTmLocationLinkDTO-allOf[1]

{
    "description":"CmTmLocationLink DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference Number"
                },
                "calendarCode":{
                    "type":"string",
                    "description":"Calendar Code"
                },
                "clearingNetwork":{
                    "type":"string",
                    "description":"Clearing Network"
                },
                "highValueCutoffAmt":{
                    "type":"number",
                    "description":"High Value Cutoff Amount"
                },
                "highValueCutoffAmtCcy":{
                    "type":"string",
                    "description":"High Value Cutoff Amount Currency"
                },
                "locationClusterCode":{
                    "type":"string",
                    "description":"Location Cluster Code"
                },
                "locationClusterDescription":{
                    "type":"string",
                    "description":"Location Cluster Description"
                },
                "locationCode":{
                    "type":"string",
                    "description":"Location Code"
                },
                "locationDescription":{
                    "type":"string",
                    "description":"Location Description"
                },
                "CmTmLocCorrBankDTO":{
                    "type":"array",
                    "description":"CmTmLocCorrBank DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocCorrBankDTO"
                    }
                },
                "CmTmLocOsNwBankDTO":{
                    "type":"array",
                    "description":"CmTmLocOsNwBank DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocOsNwBankDTO"
                    }
                },
                "CmTmLocOwnBranchDTO":{
                    "type":"array",
                    "description":"CmTmLocOwnBranch DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocOwnBranchDTO"
                    }
                }
            }
        }
    ]
}

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 : CmTmLocationLinkDTO-allOf[1]

Type: object

Show Source

calendarCode: string

Calendar Code
clearingNetwork: string

Clearing Network
CmTmLocCorrBankDTO: array CmTmLocCorrBankDTO

CmTmLocCorrBank DTO
CmTmLocOsNwBankDTO: array CmTmLocOsNwBankDTO

CmTmLocOsNwBank DTO
CmTmLocOwnBranchDTO: array CmTmLocOwnBranchDTO

CmTmLocOwnBranch DTO
highValueCutoffAmt: number

High Value Cutoff Amount
highValueCutoffAmtCcy: string

High Value Cutoff Amount Currency
locationClusterCode: string

Location Cluster Code
locationClusterDescription: string

Location Cluster Description
locationCode: string

Location Code
locationDescription: string

Location Description
txnControllerRefNo: string

Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "calendarCode":{
            "type":"string",
            "description":"Calendar Code"
        },
        "clearingNetwork":{
            "type":"string",
            "description":"Clearing Network"
        },
        "highValueCutoffAmt":{
            "type":"number",
            "description":"High Value Cutoff Amount"
        },
        "highValueCutoffAmtCcy":{
            "type":"string",
            "description":"High Value Cutoff Amount Currency"
        },
        "locationClusterCode":{
            "type":"string",
            "description":"Location Cluster Code"
        },
        "locationClusterDescription":{
            "type":"string",
            "description":"Location Cluster Description"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationDescription":{
            "type":"string",
            "description":"Location Description"
        },
        "CmTmLocCorrBankDTO":{
            "type":"array",
            "description":"CmTmLocCorrBank DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocCorrBankDTO"
            }
        },
        "CmTmLocOsNwBankDTO":{
            "type":"array",
            "description":"CmTmLocOsNwBank DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocOsNwBankDTO"
            }
        },
        "CmTmLocOwnBranchDTO":{
            "type":"array",
            "description":"CmTmLocOwnBranch DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocOwnBranchDTO"
            }
        }
    }
}

Nested Schema : CmTmLocCorrBankDTO

Type: array

CmTmLocCorrBank DTO

Show Source

Array of: object CmTmLocCorrBankDTO

CmTmLocCorrBank DTO

{
    "type":"array",
    "description":"CmTmLocCorrBank DTO",
    "items":{
        "$ref":"#/definitions/CmTmLocCorrBankDTO"
    }
}

Nested Schema : CmTmLocOsNwBankDTO

Type: array

CmTmLocOsNwBank DTO

Show Source

Array of: object CmTmLocOsNwBankDTO

CmTmLocOsNwBank DTO

{
    "type":"array",
    "description":"CmTmLocOsNwBank DTO",
    "items":{
        "$ref":"#/definitions/CmTmLocOsNwBankDTO"
    }
}

Nested Schema : CmTmLocOwnBranchDTO

Type: array

CmTmLocOwnBranch DTO

Show Source

Array of: object CmTmLocOwnBranchDTO

CmTmLocOwnBranch DTO

{
    "type":"array",
    "description":"CmTmLocOwnBranch DTO",
    "items":{
        "$ref":"#/definitions/CmTmLocOwnBranchDTO"
    }
}

Nested Schema : CmTmLocCorrBankDTO

Type: object

CmTmLocCorrBank DTO

Show Source

bankCode: string

Bank Code
bankDescription: string

Bank Description
branchCode: string

Branch Code
branchDescription: string

Branch Description
id: string

ID
locationCode: string

Location Code
locationMasterId: string

Location Master ID
priority: number

Priority

{
    "description":"CmTmLocCorrBank DTO",
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "bankDescription":{
            "type":"string",
            "description":"Bank Description"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchDescription":{
            "type":"string",
            "description":"Branch Description"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationMasterId":{
            "type":"string",
            "description":"Location Master ID"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        }
    }
}

Nested Schema : CmTmLocOsNwBankDTO

Type: object

CmTmLocOsNwBank DTO

Show Source

bankCode: string

Bank Code
bankDescription: string

Bank Description
branchCode: string

Branch Code
branchDescription: string

Branch Description
id: string

ID
locationCode: string

Location Code
locationMasterId: string

Location Master ID
priority: number

Priority

{
    "description":"CmTmLocOsNwBank DTO",
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "bankDescription":{
            "type":"string",
            "description":"Bank Description"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchDescription":{
            "type":"string",
            "description":"Branch Description"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationMasterId":{
            "type":"string",
            "description":"Location Master ID"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        }
    }
}

Nested Schema : CmTmLocOwnBranchDTO

Type: object

CmTmLocOwnBranch DTO

Show Source

branchCode: string

Branch Code
branchDescription: string

Branch Description
id: string

ID
locationCode: string

Location Code
locationMasterId: string

Location Master ID
priority: number

Priority

{
    "description":"CmTmLocOwnBranch DTO",
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchDescription":{
            "type":"string",
            "description":"Branch Description"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationMasterId":{
            "type":"string",
            "description":"Location Master ID"
        }
    }
}

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