Jump to

• Request
• Response

Run Sweep for a Structure asynchronously

post

/sweepservice/structureasync

This endpoint is used to run sweep service for a structure asynchronously.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for running a sweep batch

Root Schema : LmsSweepStructuresDTO

Type: object

Match All

Show Source

• object LmsSweepStructuresDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "mode":{
                    "type":"string",
                    "description":""
                },
                "overRidePending":{
                    "type":"string",
                    "description":""
                },
                "branchCode":{
                    "type":"string",
                    "description":""
                },
                "jobschedulerId":{
                    "type":"string",
                    "description":""
                },
                "allowMBCCAccPair":{
                    "type":"string",
                    "description":""
                },
                "simulate":{
                    "type":"string",
                    "description":""
                },
                "simulateFromDt":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "simulateToDt":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "simulateExecDt":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "adhocId":{
                    "type":"string",
                    "description":""
                },
                "remarks":{
                    "type":"string",
                    "description":""
                },
                "allStructure":{
                    "type":"string",
                    "description":""
                },
                "checkAccPairSweep":{
                    "type":"string",
                    "description":""
                },
                "structureList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/StructureListDTO"
                    }
                },
                "branchMap":{
                    "$ref":"#/definitions/BranchMap"
                }
            }
        }
    ]
}

Nested Schema : LmsSweepStructuresDTO-allOf[0]

Type: object

Show Source

• adhocId: string
• allowMBCCAccPair: string
• allStructure: string
• branchCode: string
• branchMap: object BranchMap
  Additional Properties Allowed: LmmTmBranchParametersDTO
• checkAccPairSweep: string
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• jobschedulerId: string
• mode: string
• overRidePending: string
• remarks: string
• simulate: string
• simulateExecDt: string(date)
• simulateFromDt: string(date)
• simulateToDt: string(date)
• structureList: array structureList

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "mode":{
            "type":"string",
            "description":""
        },
        "overRidePending":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "jobschedulerId":{
            "type":"string",
            "description":""
        },
        "allowMBCCAccPair":{
            "type":"string",
            "description":""
        },
        "simulate":{
            "type":"string",
            "description":""
        },
        "simulateFromDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "simulateToDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "simulateExecDt":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "adhocId":{
            "type":"string",
            "description":""
        },
        "remarks":{
            "type":"string",
            "description":""
        },
        "allStructure":{
            "type":"string",
            "description":""
        },
        "checkAccPairSweep":{
            "type":"string",
            "description":""
        },
        "structureList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StructureListDTO"
            }
        },
        "branchMap":{
            "$ref":"#/definitions/BranchMap"
        }
    }
}

Nested Schema : BranchMap

Type: object

Additional Properties Allowed

Show Source

• object LmmTmBranchParametersDTO

{
    "additionalProperties":{
        "$ref":"#/definitions/LmmTmBranchParametersDTO"
    }
}

Nested Schema : structureList

Type: array

Show Source

• Array of: object StructureListDTO

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

Nested Schema : LmmTmBranchParametersDTO

Type: object

Show Source

• bankCode: string
• bicCode: string
• branchCode: string

{
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":""
        },
        "bicCode":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : StructureListDTO

Type: object

Show Source

• accountList: array accountList
• baseExtTxnNumber: integer(int64)
  Base Ext transaction number for BVT calculation
• lastSuccessfulSweepDate: string(date)
• structureId: string
  Pattern: [0-9a-fA-Z-]{1,36}
• valueDate: string
  Value Date. This field is sent if this date needs to be considered as branch date. Used to trigger BVT execution
• versionNo: integer
  Structure Mod to be used

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "versionNo":{
            "type":"integer",
            "description":"Structure Mod to be used"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date. This field is sent if this date needs to be considered as branch date. Used to trigger BVT execution"
        },
        "baseExtTxnNumber":{
            "type":"integer",
            "format":"int64",
            "description":"Base Ext transaction number for BVT calculation"
        },
        "lastSuccessfulSweepDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "accountList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmsSweepAccountDTO"
            }
        }
    }
}

Nested Schema : accountList

Type: array

Show Source

• Array of: object LmsSweepAccountDTO

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

Nested Schema : LmsSweepAccountDTO

Type: object

Show Source

• accountCurrency: string
• accountNumber: string
• batchDataId: string
• branchCode: string
• extTransactionNo: string
  Sweep Log ID
• frequencyId: string
• fromDate: string
  starting Date
• id: string
• instructionId: string
• lastSuccessfulSweepDate: string(date)
• structureMasterId: string
• toDate: string
  ending Date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureMasterId":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "batchDataId":{
            "type":"string",
            "description":""
        },
        "accountCurrency":{
            "type":"string",
            "description":""
        },
        "instructionId":{
            "type":"string",
            "description":""
        },
        "frequencyId":{
            "type":"string",
            "description":""
        },
        "lastSuccessfulSweepDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "fromDate":{
            "description":"starting Date",
            "type":"string"
        },
        "toDate":{
            "description":"ending Date",
            "type":"string"
        },
        "extTransactionNo":{
            "description":"Sweep Log ID",
            "type":"string"
        }
    }
}

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 created sweepmaster data

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: 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: array codes
• id: string
• requestId: string
• status: 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: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: 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