Jump to

• Request
• Response

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":"[0-9a-fA-Z-]{1,36}"
                },
                "structureDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":200
                },
                "structureMasterId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "versionNo":{
                    "type":"integer",
                    "description":""
                },
                "effectiveDate":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "overRidePendingSweep":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "includeExternalAccount":{
                    "type":"string",
                    "description":"",
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "executionType":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "status":{
                    "type":"string",
                    "description":""
                },
                "sweepStatus":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "sweepId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "headerBranchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "requestId":{
                    "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
  Maximum Length: 100
• effectiveDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• executionType(optional): string
  Maximum Length: 1
• headerBranchCode(optional): string
  Maximum Length: 4
• includeExternalAccount(optional): string
  Maximum Length: 1

  Pattern: [Y,N]
• LmsTbAdhocAccpairSweepDTO(optional): array LmsTbAdhocAccpairSweepDTO
• overRidePendingSweep(optional): string
  Maximum Length: 1
• requestId(optional): string
• status(optional): string
• structureDescription(optional): string
  Maximum Length: 200
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}
• structureMasterId(optional): string
  Maximum Length: 36
• sweepId(optional): string
  Maximum Length: 36
• sweepStatus(optional): string
  Maximum Length: 1
• versionNo(optional): integer

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "structureDescription":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "structureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "versionNo":{
            "type":"integer",
            "description":""
        },
        "effectiveDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "overRidePendingSweep":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "includeExternalAccount":{
            "type":"string",
            "description":"",
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "executionType":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "status":{
            "type":"string",
            "description":""
        },
        "sweepStatus":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "sweepId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "headerBranchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "requestId":{
            "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
  Maximum Length: 30
• adhocSweepStrMasterId(optional): string
  Maximum Length: 36
• branchCode(optional): string
  Maximum Length: 4
• currencyCode(optional): string
  Maximum Length: 3
• id(optional): string
  Maximum Length: 36
• instructionId(optional): string
  Maximum Length: 200
• instructionPriority(optional): string
  Maximum Length: 36
• parentAccountBranch(optional): string
  Maximum Length: 4
• parentAccountCurrency(optional): string
  Maximum Length: 3
• parentAccountNumber(optional): string
  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "adhocSweepStrMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "accountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "instructionId":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "instructionPriority":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "currencyCode":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "parentAccountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "parentAccountBranch":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "parentAccountCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        }
    }
}

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