Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the list of existing Scheduled Sweeps

get

/service/lms/scheduledsweeps

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

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  fetch record according to customerId
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
  fetch record according to structureId

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Successful performs the operation
Body ()
Root Schema : LmdTbScheduledSweepsServiceCollection
Type: `object`
Collection of ScheduledSweeps
Show Source

- data(optional): array data
- paging(optional): 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(optional): 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"
                    },
                    "branchCode":{
                        "description":"branchCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"currencyCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "customerId":{
                        "description":"customerId in Scheduled Sweeps",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "instructionDesription":{
                        "description":"instructionDesription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "instructionId":{
                        "description":"instructionId in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentAccountNumber":{
                        "description":"parentAccountNumber in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentBranchCode":{
                        "description":"parentBranchCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentCurrencyCode":{
                        "description":"parentCurrencyCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "productCode":{
                        "description":"productCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "productDescription":{
                        "description":"productDescription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "structureDescription":{
                        "description":"structureDescription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "structureId":{
                        "description":"structureId in Scheduled Sweeps",
                        "type":"string",
                        "pattern":"[0-9a-fA-Z-]{1,36}"
                    },
                    "nextRunDate":{
                        "description":"nextRunDate 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

- accountNumber(optional): string
  accountNumber in Scheduled Sweeps
- branchCode(optional): string
  branchCode in Scheduled Sweeps
- currencyCode(optional): string
  currencyCode in Scheduled Sweeps
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  customerId in Scheduled Sweeps
- instructionDesription(optional): string
  instructionDesription in Scheduled Sweeps
- instructionId(optional): string
  instructionId in Scheduled Sweeps
- nextRunDate(optional): string
  nextRunDate in Scheduled Sweeps
- parentAccountNumber(optional): string
  parentAccountNumber in Scheduled Sweeps
- parentBranchCode(optional): string
  parentBranchCode in Scheduled Sweeps
- parentCurrencyCode(optional): string
  parentCurrencyCode in Scheduled Sweeps
- productCode(optional): string
  productCode in Scheduled Sweeps
- productDescription(optional): string
  productDescription in Scheduled Sweeps
- structureDescription(optional): string
  structureDescription in Scheduled Sweeps
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
  structureId in Scheduled Sweeps

    {
        "type":"object",
        "properties":{
            "accountNumber":{
                "description":"accountNumber in Scheduled Sweeps",
                "type":"string"
            },
            "branchCode":{
                "description":"branchCode in Scheduled Sweeps",
                "type":"string"
            },
            "currencyCode":{
                "description":"currencyCode in Scheduled Sweeps",
                "type":"string"
            },
            "customerId":{
                "description":"customerId in Scheduled Sweeps",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "instructionDesription":{
                "description":"instructionDesription in Scheduled Sweeps",
                "type":"string"
            },
            "instructionId":{
                "description":"instructionId in Scheduled Sweeps",
                "type":"string"
            },
            "parentAccountNumber":{
                "description":"parentAccountNumber in Scheduled Sweeps",
                "type":"string"
            },
            "parentBranchCode":{
                "description":"parentBranchCode in Scheduled Sweeps",
                "type":"string"
            },
            "parentCurrencyCode":{
                "description":"parentCurrencyCode in Scheduled Sweeps",
                "type":"string"
            },
            "productCode":{
                "description":"productCode in Scheduled Sweeps",
                "type":"string"
            },
            "productDescription":{
                "description":"productDescription in Scheduled Sweeps",
                "type":"string"
            },
            "structureDescription":{
                "description":"structureDescription in Scheduled Sweeps",
                "type":"string"
            },
            "structureId":{
                "description":"structureId in Scheduled Sweeps",
                "type":"string",
                "pattern":"[0-9a-fA-Z-]{1,36}"
            },
            "nextRunDate":{
                "description":"nextRunDate 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
Back to Top