Rest API for Oracle Banking Liquidity Management Cloud Service

Retrieves the customers by given parent customerID.

get

/service/customer/getAllCustomers

This endpoint is used to get the customer by parent customerID.

Request

Supported Media Types

application/json
application/xml

Query Parameters

customerId: string

Id of the customer that needs to be fetched
customerName: string

customer name that needs to be fetched
parentCustomerId: string

Id of the customer that needs to be fetched

Header Parameters

sourceCode(required): string

Source from which request is initiated

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the customer based on given id.

Root Schema : LmmTmCustomerCollection

Type: object

Collection of customer.

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object LmmTmCustomerDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : LmmTmCustomerDTO

Type: object

Match All

Show Source

allOf GenericDto
object LmmTmCustomerDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":"140"
                },
                "parentCustomerId":{
                    "type":"string",
                    "description":"",
                    "maxLength":"20"
                },
                "address":{
                    "type":"string",
                    "description":"",
                    "maxLength":"1000"
                },
                "bankCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":"4"
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":"4"
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":"35"
                },
                "sourceSystemCustNo":{
                    "type":"string",
                    "description":"",
                    "maxLength":"50"
                },
                "closedStat":{
                    "type":"string",
                    "description":""
                },
                "closedDtStamp":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "isForgotten":{
                    "type":"string",
                    "description":""
                }
            },
            "required":[
                "customerId",
                "customerName"
            ]
        }
    ]
}

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

Type: object

Show Source

address: string

Maximum Length: 1000
bankCode: string

Maximum Length: 4
branchCode: string

Maximum Length: 4
closedDtStamp: string(date)
closedStat: string
customerId(required): string

Pattern: [a-zA-Z0-9]{1,20}
customerName(required): string

Maximum Length: 140
isForgotten: string
parentCustomerId: string

Maximum Length: 20
sourceSystem: string

Maximum Length: 35
sourceSystemCustNo: string

Maximum Length: 50

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":"140"
        },
        "parentCustomerId":{
            "type":"string",
            "description":"",
            "maxLength":"20"
        },
        "address":{
            "type":"string",
            "description":"",
            "maxLength":"1000"
        },
        "bankCode":{
            "type":"string",
            "description":"",
            "maxLength":"4"
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":"4"
        },
        "sourceSystem":{
            "type":"string",
            "description":"",
            "maxLength":"35"
        },
        "sourceSystemCustNo":{
            "type":"string",
            "description":"",
            "maxLength":"50"
        },
        "closedStat":{
            "type":"string",
            "description":""
        },
        "closedDtStamp":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "isForgotten":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "customerId",
        "customerName"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error