Previous Next JavaScript must be enabled to correctly display this content

## Get all valid batch

get

/batch

This endpoint is used to get all valid batch maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- structureMasterId(optional): string
  structureMasterId need to be set to fetch batch Data for particular structureMasterId

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string

Body ()
Root Schema : LmsTbSweepDataCollection
Type: `object`
Collection of batch data.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmsTbSweepDataDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LmsTbSweepDataDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmsTbSweepDataDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "accountNumber":{
                        "type":"string",
                        "description":""
                    },
                    "branchCode":{
                        "type":"string",
                        "description":""
                    },
                    "currencyCode":{
                        "type":"string",
                        "description":""
                    },
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "frequencyCategory":{
                        "type":"string",
                        "description":""
                    },
                    "instructionId":{
                        "type":"string",
                        "description":""
                    },
                    "isEodExecution":{
                        "type":"string",
                        "description":""
                    },
                    "lastExecutionTime":{
                        "type":"string",
                        "description":""
                    },
                    "nextExecutionDate":{
                        "type":"string",
                        "description":""
                    },
                    "lastSuccessfulSweepDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "parentAccountNumber":{
                        "type":"string",
                        "description":""
                    },
                    "parentBranchCode":{
                        "type":"string",
                        "description":""
                    },
                    "parentCurrencyCode":{
                        "type":"string",
                        "description":""
                    },
                    "priority":{
                        "type":"number",
                        "description":""
                    },
                    "status":{
                        "type":"string",
                        "description":""
                    },
                    "statusMessage":{
                        "type":"string",
                        "description":""
                    },
                    "structureId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[0-9a-fA-Z-]{1,36}"
                    },
                    "structureMasterId":{
                        "type":"string",
                        "description":""
                    },
                    "structureDetailsId":{
                        "type":"string",
                        "description":""
                    },
                    "frequencyId":{
                        "type":"string",
                        "description":""
                    },
                    "isBodExecution":{
                        "type":"string",
                        "description":""
                    },
                    "backwardTreatment":{
                        "type":"string",
                        "description":""
                    },
                    "holidayTreatment":{
                        "type":"string",
                        "description":""
                    },
                    "maxBackwardDays":{
                        "type":"integer",
                        "description":""
                    },
                    "batchStatus":{
                        "type":"string",
                        "description":""
                    },
                    "suspensionStartDate":{
                        "type":"string",
                        "description":""
                    },
                    "suspensionEndDate":{
                        "type":"string",
                        "description":""
                    },
                    "isReverseSweep":{
                        "type":"string",
                        "description":""
                    }
                }
            }
        ]
    }

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 : LmsTbSweepDataDTO-allOf[1]
Type: `object`
Show Source

- accountNumber(optional): string
- backwardTreatment(optional): string
- batchStatus(optional): string
- branchCode(optional): string
- currencyCode(optional): string
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- effectiveDate(optional): string(date)
- frequencyCategory(optional): string
- frequencyId(optional): string
- holidayTreatment(optional): string
- instructionId(optional): string
- isBodExecution(optional): string
- isEodExecution(optional): string
- isReverseSweep(optional): string
- lastExecutionTime(optional): string
- lastSuccessfulSweepDate(optional): string(date)
- maxBackwardDays(optional): integer
- nextExecutionDate(optional): string
- parentAccountNumber(optional): string
- parentBranchCode(optional): string
- parentCurrencyCode(optional): string
- priority(optional): number
- status(optional): string
- statusMessage(optional): string
- structureDetailsId(optional): string
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
- structureMasterId(optional): string
- suspensionEndDate(optional): string
- suspensionStartDate(optional): string

    {
        "type":"object",
        "properties":{
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "currencyCode":{
                "type":"string",
                "description":""
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "frequencyCategory":{
                "type":"string",
                "description":""
            },
            "instructionId":{
                "type":"string",
                "description":""
            },
            "isEodExecution":{
                "type":"string",
                "description":""
            },
            "lastExecutionTime":{
                "type":"string",
                "description":""
            },
            "nextExecutionDate":{
                "type":"string",
                "description":""
            },
            "lastSuccessfulSweepDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "parentAccountNumber":{
                "type":"string",
                "description":""
            },
            "parentBranchCode":{
                "type":"string",
                "description":""
            },
            "parentCurrencyCode":{
                "type":"string",
                "description":""
            },
            "priority":{
                "type":"number",
                "description":""
            },
            "status":{
                "type":"string",
                "description":""
            },
            "statusMessage":{
                "type":"string",
                "description":""
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[0-9a-fA-Z-]{1,36}"
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "structureDetailsId":{
                "type":"string",
                "description":""
            },
            "frequencyId":{
                "type":"string",
                "description":""
            },
            "isBodExecution":{
                "type":"string",
                "description":""
            },
            "backwardTreatment":{
                "type":"string",
                "description":""
            },
            "holidayTreatment":{
                "type":"string",
                "description":""
            },
            "maxBackwardDays":{
                "type":"integer",
                "description":""
            },
            "batchStatus":{
                "type":"string",
                "description":""
            },
            "suspensionStartDate":{
                "type":"string",
                "description":""
            },
            "suspensionEndDate":{
                "type":"string",
                "description":""
            },
            "isReverseSweep":{
                "type":"string",
                "description":""
            }
        }
    }

#### 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
Back to Top