Jump to

• Request
• Response

Get all valid reverse sweep monitor

get

/reversesweepmonitor

This endpoint is used to get all valid reverse sweep monitor maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• filterBy(optional): string
• fromDate(optional): string
• 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
• reversesweepmasterid(optional): string
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}
• toDate(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmsTbReverseSweepLogCollection

Type: object

Collection of reversesweeplog.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmsTbReverseSweepMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmsTbReverseSweepMasterDTO

Type: object

Show Source

• accountnumber(optional): string
• branchcode(optional): string
• currencycode(optional): string
• executionId(optional): string
• id(optional): string
• lastExecutionTime(optional): string(date)
• LmsTbReverseSweepLogDTO(optional): array LmsTbReverseSweepLogDTO
• nextExecutionDate(optional): string(date)
• reverseSweepFrequency(optional): string
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "accountnumber":{
            "type":"string",
            "description":""
        },
        "branchcode":{
            "type":"string",
            "description":""
        },
        "currencycode":{
            "type":"string",
            "description":""
        },
        "executionId":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "lastExecutionTime":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "nextExecutionDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "reverseSweepFrequency":{
            "type":"string",
            "description":""
        },
        "LmsTbReverseSweepLogDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmsTbReverseSweepLogDTO"
            }
        }
    }
}

Nested Schema : LmsTbReverseSweepLogDTO

Type: array

Show Source

• Array of: object LmsTbReverseSweepLogDTO

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

Nested Schema : LmsTbReverseSweepLogDTO

Type: object

Show Source

• bvtid(optional): string
• customerid(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• executionid(optional): string
• extTransactionNo(optional): string
• fromAccountBalance(optional): number
• fromAccountNumber(optional): string
• fromAccountPostBal(optional): number
• fromAmount(optional): number
• fromBicCode(optional): string
• fromBranchCode(optional): string
• fromCurrencyCode(optional): string
• fxRate(optional): number
• id(optional): string
• instructionId(optional): string
• isTwoway(optional): string
• logTime(optional): string
• modNo(optional): number
• reversalAmount(optional): number
• reversalDate(optional): string(date)
• reversesweepmasterid(optional): string
• status(optional): string
• statusMessage(optional): string
• structureId(optional): string
  Pattern: [0-9a-fA-Z-]{1,36}
• sweepProduct(optional): string
• toAccountBalance(optional): number
• toAccountNumber(optional): string
• toAccountPostBal(optional): number
• toAmount(optional): number
• toBicCode(optional): string
• toBranchCode(optional): string
• toCurrencyCode(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "reversesweepmasterid":{
            "type":"string",
            "description":""
        },
        "bvtid":{
            "type":"string",
            "description":""
        },
        "customerid":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "executionid":{
            "type":"string",
            "description":""
        },
        "extTransactionNo":{
            "type":"string",
            "description":""
        },
        "fromAccountBalance":{
            "type":"number",
            "description":""
        },
        "fromAccountNumber":{
            "type":"string",
            "description":""
        },
        "fromAccountPostBal":{
            "type":"number",
            "description":""
        },
        "fromAmount":{
            "type":"number",
            "description":""
        },
        "fromBicCode":{
            "type":"string",
            "description":""
        },
        "fromBranchCode":{
            "type":"string",
            "description":""
        },
        "fromCurrencyCode":{
            "type":"string",
            "description":""
        },
        "fxRate":{
            "type":"number",
            "description":""
        },
        "instructionId":{
            "type":"string",
            "description":""
        },
        "isTwoway":{
            "type":"string",
            "description":""
        },
        "logTime":{
            "type":"string",
            "description":""
        },
        "modNo":{
            "type":"number",
            "description":""
        },
        "reversalAmount":{
            "type":"number",
            "description":""
        },
        "reversalDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "statusMessage":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "sweepProduct":{
            "type":"string",
            "description":""
        },
        "toAccountBalance":{
            "type":"number",
            "description":""
        },
        "toAccountNumber":{
            "type":"string",
            "description":""
        },
        "toAccountPostBal":{
            "type":"number",
            "description":""
        },
        "toAmount":{
            "type":"number",
            "description":""
        },
        "toBicCode":{
            "type":"string",
            "description":""
        },
        "toBranchCode":{
            "type":"string",
            "description":""
        },
        "toCurrencyCode":{
            "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