Rest API for Oracle Banking Liquidity Management

Retrieves the list of existing ScheduledSweeps.

get

/api/1.0/service/lmd/scheduledsweeps

This endpoint is used to get the list of existing scheduled sweeps.

Request

Supported Media Types

application/json
application/xml

Query Parameters

customerId: string

Pattern: [a-zA-Z0-9]{1,20}

fetch record according to customerId
fromDate: string

fetch record according to fromDate
limit: integer

limit is maximum no of records to be fetched
offset: integer

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

Maximum Length: 30

fetch record according to structureId
toDate: string

fetch record according to toDate

Header Parameters

sourceCode(required): string

Source from which request is initiated

Response

Supported Media Types

application/json
application/xml

200 Response

Successful performs the operation

Root Schema : LmdTbScheduledSweepsServiceCollection

Type: object

Collection of ScheduledSweeps

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object LmdTbScheduledSweepsDTO

ScheduledSweeps DTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : LmdTbScheduledSweepsDTO

Type: object

ScheduledSweeps DTO

Match All

Show Source

allOf GenericDto
object LmdTbScheduledSweepsDTO-allOf[1]

{
    "description":"ScheduledSweeps DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "accountNumber":{
                    "description":"accountNumber in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"35"
                },
                "branchCode":{
                    "description":"branchCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"4"
                },
                "currencyCode":{
                    "description":"currencyCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"3"
                },
                "customerId":{
                    "description":"customerId in Scheduled Sweeps",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "instructionDesription":{
                    "description":"instructionDesription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"200"
                },
                "instructionId":{
                    "description":"instructionId in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"10"
                },
                "parentAccountNumber":{
                    "description":"parentAccountNumber in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"35"
                },
                "parentBranchCode":{
                    "description":"parentBranchCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"4"
                },
                "parentCurrencyCode":{
                    "description":"parentCurrencyCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"3"
                },
                "productCode":{
                    "description":"productCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"10"
                },
                "productDescription":{
                    "description":"productDescription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"200"
                },
                "structureDescription":{
                    "description":"structureDescription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":"200"
                },
                "structureId":{
                    "description":"structureId in Scheduled Sweeps",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "nextRunDate":{
                    "description":"nextRunDate in Scheduled Sweeps",
                    "type":"string"
                },
                "accountName":{
                    "description":"accountName in Scheduled Sweeps",
                    "type":"string"
                },
                "parentAccountName":{
                    "description":"parentAccountName in Scheduled Sweeps",
                    "type":"string"
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

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

Type: object

Show Source

accountName: string

accountName in Scheduled Sweeps
accountNumber: string

Maximum Length: 35

accountNumber in Scheduled Sweeps
branchCode: string

Maximum Length: 4

branchCode in Scheduled Sweeps
currencyCode: string

Maximum Length: 3

currencyCode in Scheduled Sweeps
customerId: string

Pattern: [a-zA-Z0-9]{1,20}

customerId in Scheduled Sweeps
instructionDesription: string

Maximum Length: 200

instructionDesription in Scheduled Sweeps
instructionId: string

Maximum Length: 10

instructionId in Scheduled Sweeps
nextRunDate: string

nextRunDate in Scheduled Sweeps
parentAccountName: string

parentAccountName in Scheduled Sweeps
parentAccountNumber: string

Maximum Length: 35

parentAccountNumber in Scheduled Sweeps
parentBranchCode: string

Maximum Length: 4

parentBranchCode in Scheduled Sweeps
parentCurrencyCode: string

Maximum Length: 3

parentCurrencyCode in Scheduled Sweeps
productCode: string

Maximum Length: 10

productCode in Scheduled Sweeps
productDescription: string

Maximum Length: 200

productDescription in Scheduled Sweeps
structureDescription: string

Maximum Length: 200

structureDescription in Scheduled Sweeps
structureId: string

Pattern: [A-Z0-9]{1,30}

structureId in Scheduled Sweeps

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "description":"accountNumber in Scheduled Sweeps",
            "type":"string",
            "maxLength":"35"
        },
        "branchCode":{
            "description":"branchCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":"4"
        },
        "currencyCode":{
            "description":"currencyCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":"3"
        },
        "customerId":{
            "description":"customerId in Scheduled Sweeps",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "instructionDesription":{
            "description":"instructionDesription in Scheduled Sweeps",
            "type":"string",
            "maxLength":"200"
        },
        "instructionId":{
            "description":"instructionId in Scheduled Sweeps",
            "type":"string",
            "maxLength":"10"
        },
        "parentAccountNumber":{
            "description":"parentAccountNumber in Scheduled Sweeps",
            "type":"string",
            "maxLength":"35"
        },
        "parentBranchCode":{
            "description":"parentBranchCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":"4"
        },
        "parentCurrencyCode":{
            "description":"parentCurrencyCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":"3"
        },
        "productCode":{
            "description":"productCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":"10"
        },
        "productDescription":{
            "description":"productDescription in Scheduled Sweeps",
            "type":"string",
            "maxLength":"200"
        },
        "structureDescription":{
            "description":"structureDescription in Scheduled Sweeps",
            "type":"string",
            "maxLength":"200"
        },
        "structureId":{
            "description":"structureId in Scheduled Sweeps",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "nextRunDate":{
            "description":"nextRunDate in Scheduled Sweeps",
            "type":"string"
        },
        "accountName":{
            "description":"accountName in Scheduled Sweeps",
            "type":"string"
        },
        "parentAccountName":{
            "description":"parentAccountName in Scheduled Sweeps",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error