Execute Sweep for a Structure from channel
post
                    /sweepservice/executesweepobdx
This endpoint is used to execute sweep for a structure for external source system like OBDX.
                Request
Supported Media Types
                - application/json
- application/xml
Request Body that contains data required for running a sweep batch
                
                
                
                Nested Schema : LmsSweepStructuresDTO-allOf[0]
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            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
            
            
Nested Schema : LmmTmBranchParametersDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            balanceUpdateOffset: 
            integer
            
- 
            bankCode: 
            string
            
- 
            bankType: 
            string
            
- 
            bicCode: 
            string
            
- 
            branchCode: 
            string
            
- 
            branchCurrency: 
            string
            
- 
            branchDate: 
            string
            
- 
            branchName: 
            string
            
- 
            cityId: 
            string
            
- 
            countryId: 
            string
            
- 
            crossBorderHybridPool: 
            string
            
- 
            crossBorderHybridSweep: 
            string
            
- 
            crossBorderPool: 
            string
            
- 
            crossBorderSweep: 
            string
            
- 
            crossCcyHybridPool: 
            string
            
- 
            crossCcyHybridSweep: 
            string
            
- 
            crossCcyPool: 
            string
            
- 
            crossCcySweep: 
            string
            
- 
            domesticHybridPool: 
            string
            
- 
            domesticHybridSweep: 
            string
            
- 
            domesticPool: 
            string
            
- 
            domesticSweep: 
            string
            
- 
            externalSystemId: 
            string
            
- 
            fax: 
            string
            
- 
            hostCode: 
            string
            
- 
            hybrid: 
            string
            
- 
            isBalanceOnline: 
            string
            
- 
            isExternal: 
            string
            
- 
            latitude: 
            number
            
- 
            line1: 
            string
            
- 
            line2: 
            string
            
- 
            line3: 
            string
            
- 
            line4: 
            string
            
- 
            LmmTmBranchAddnParametersDTO: 
            array  LmmTmBranchAddnParametersDTO
            
            
- 
            LmmTmBranchExternalSystemDTO: 
            array  LmmTmBranchExternalSystemDTO
            
            
- 
            localClearingCode: 
            string
            
- 
            longitude: 
            number
            
- 
            phoneNumber: 
            string
            
- 
            pool: 
            string
            
- 
            region: 
            string
            
- 
            sourceSystem: 
            string
            
- 
            sourceSystemBranchCode: 
            string
            
- 
            stateId: 
            string
            
- 
            sweep: 
            string
            
- 
            timeZone: 
            string
            
- 
            zip: 
            string
            
Nested Schema : StructureListDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            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
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
Nested Schema : ResponseResourceSupport
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
objectNested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
object400 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