Previous Next JavaScript must be enabled to correctly display this content

## Initiate Sweep Structure

post

/sweepservice/adhoc/initiateSweep

This endpoint is used to initiate sweep structure for checker to authorize.

### Request

Supported Media Types

- application/json
- application/xml

Body ()
Request Body that contains data required for initiating structure
Root Schema : LmsTbAdhocStrSweepCollection
Type: `object`
Collection of structures.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmsTbAdhocStrSweepDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

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

- allOf GenericDto
- object LmsTbAdhocStrSweepDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "structureId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "structureDescription":{
                        "type":"string",
                        "description":""
                    },
                    "structureMasterId":{
                        "type":"string",
                        "description":""
                    },
                    "versionNo":{
                        "type":"integer",
                        "description":""
                    },
                    "effectiveDate":{
                        "type":"string",
                        "description":""
                    },
                    "overRidePendingSweep":{
                        "type":"string",
                        "description":""
                    },
                    "includeExternalAccount":{
                        "type":"string",
                        "description":""
                    },
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "customerName":{
                        "type":"string",
                        "description":""
                    },
                    "executionType":{
                        "type":"string",
                        "description":""
                    },
                    "status":{
                        "type":"string",
                        "description":""
                    },
                    "sweepStatus":{
                        "type":"string",
                        "description":""
                    },
                    "sweepId":{
                        "type":"string",
                        "description":""
                    },
                    "headerBranchCode":{
                        "type":"string",
                        "description":""
                    },
                    "LmsTbAdhocAccpairSweepDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmsTbAdhocAccpairSweepDTO"
                        }
                    }
                }
            }
        ]
    }

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

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string
- effectiveDate(optional): string
- executionType(optional): string
- headerBranchCode(optional): string
- includeExternalAccount(optional): string
- LmsTbAdhocAccpairSweepDTO(optional): array LmsTbAdhocAccpairSweepDTO
- overRidePendingSweep(optional): string
- status(optional): string
- structureDescription(optional): string
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId(optional): string
- sweepId(optional): string
- sweepStatus(optional): string
- versionNo(optional): integer

    {
        "type":"object",
        "properties":{
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureDescription":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "versionNo":{
                "type":"integer",
                "description":""
            },
            "effectiveDate":{
                "type":"string",
                "description":""
            },
            "overRidePendingSweep":{
                "type":"string",
                "description":""
            },
            "includeExternalAccount":{
                "type":"string",
                "description":""
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "type":"string",
                "description":""
            },
            "executionType":{
                "type":"string",
                "description":""
            },
            "status":{
                "type":"string",
                "description":""
            },
            "sweepStatus":{
                "type":"string",
                "description":""
            },
            "sweepId":{
                "type":"string",
                "description":""
            },
            "headerBranchCode":{
                "type":"string",
                "description":""
            },
            "LmsTbAdhocAccpairSweepDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmsTbAdhocAccpairSweepDTO"
                }
            }
        }
    }

Nested Schema : LmsTbAdhocAccpairSweepDTO
Type: `array`
Show Source

- Array of: object LmsTbAdhocAccpairSweepDTO

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

Nested Schema : LmsTbAdhocAccpairSweepDTO
Type: `object`
Show Source

- accountNumber(optional): string
- adhocSweepStrMasterId(optional): string
- branchCode(optional): string
- currencyCode(optional): string
- id(optional): string
- instructionId(optional): string
- instructionPriority(optional): string
- parentAccountBranch(optional): string
- parentAccountCurrency(optional): string
- parentAccountNumber(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "adhocSweepStrMasterId":{
                "type":"string",
                "description":""
            },
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "instructionId":{
                "type":"string",
                "description":""
            },
            "instructionPriority":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "currencyCode":{
                "type":"string",
                "description":""
            },
            "parentAccountNumber":{
                "type":"string",
                "description":""
            },
            "parentAccountBranch":{
                "type":"string",
                "description":""
            },
            "parentAccountCurrency":{
                "type":"string",
                "description":""
            }
        }
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string
  URL of newly initated structure

Body ()
Root Schema : ResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object ResponseResourceSupport
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/ResponseResourceSupport"
            }
        }
    }

Nested Schema : ResponseResourceSupport
Type: `object`
Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

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

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 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