Jump to

• Request
• Response

Generate sweep report

post

/simulation/generateSweepReport

This endpoint is used to generate sweep benefit report along with log summary.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating sweep simulation report

Root Schema : LmrSimulationSweepReportDTO

Type: object

Show Source

• benefitReportBody(optional): array benefitReportBody
• benefitReportHeader(optional): object BenefitReportHeaderDTO
• benefitSummary(optional): object BenefitSummaryDTO
• sweepLogReportBody(optional): array sweepLogReportBody
• sweepLogReportHeader(optional): object SweepLogReportHeaderDTO

{
    "type":"object",
    "properties":{
        "benefitReportHeader":{
            "type":"object",
            "$ref":"#/definitions/BenefitReportHeaderDTO"
        },
        "benefitReportBody":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BenefitReportBodyDTO"
            }
        },
        "sweepLogReportHeader":{
            "type":"object",
            "$ref":"#/definitions/SweepLogReportHeaderDTO"
        },
        "sweepLogReportBody":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SweepLogReportBodyDTO"
            }
        },
        "benefitSummary":{
            "type":"object",
            "$ref":"#/definitions/BenefitSummaryDTO"
        }
    }
}

Nested Schema : benefitReportBody

Type: array

Show Source

• Array of: object BenefitReportBodyDTO

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

Nested Schema : BenefitReportHeaderDTO

Type: object

Show Source

• fromDt(optional): string
• generatedBy(optional): string
• generatedOn(optional): string
• headerAccount(optional): string
• headerCcy(optional): string
• simulationId(optional): string
• structureDesc(optional): string
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• structureType(optional): string
• toDt(optional): string

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        },
        "structureType":{
            "type":"string",
            "description":""
        },
        "simulationId":{
            "type":"string",
            "description":""
        },
        "fromDt":{
            "type":"string",
            "description":""
        },
        "toDt":{
            "type":"string",
            "description":""
        },
        "headerAccount":{
            "type":"string",
            "description":""
        },
        "headerCcy":{
            "type":"string",
            "description":""
        },
        "generatedOn":{
            "type":"string",
            "description":""
        },
        "generatedBy":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : BenefitSummaryDTO

Type: object

Show Source

• simulationBenefit(optional): number
• totalPostSweepIntHdrCcy(optional): number
• totalPreSweepIntHdrCcy(optional): number

{
    "type":"object",
    "properties":{
        "totalPostSweepIntHdrCcy":{
            "type":"number",
            "description":""
        },
        "totalPreSweepIntHdrCcy":{
            "type":"number",
            "description":""
        },
        "simulationBenefit":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : sweepLogReportBody

Type: array

Show Source

• Array of: object SweepLogReportBodyDTO

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

Nested Schema : SweepLogReportHeaderDTO

Type: object

Show Source

• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(optional): string
• fromDate(optional): string
• simulationDesc(optional): string
• simulationId(optional): string
• toDate(optional): string

{
    "properties":{
        "simulationId":{
            "type":"string",
            "description":""
        },
        "simulationDesc":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "fromDate":{
            "type":"string",
            "description":""
        },
        "toDate":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : BenefitReportBodyDTO

Type: object

Show Source

• accountDesc(optional): string
• accountNo(optional): string
• branch(optional): string
• branchDesc(optional): string
• ccy(optional): string
• headerCcy(optional): string
• postSweepIntAccCcy(optional): number
• postSweepIntHeaderCcy(optional): number
• preSweepIntAccCcy(optional): number
• preSweepIntHeaderCcy(optional): number

{
    "type":"object",
    "properties":{
        "accountNo":{
            "type":"string",
            "description":""
        },
        "accountDesc":{
            "type":"string",
            "description":""
        },
        "ccy":{
            "type":"string",
            "description":""
        },
        "headerCcy":{
            "type":"string",
            "description":""
        },
        "branch":{
            "type":"string",
            "description":""
        },
        "branchDesc":{
            "type":"string",
            "description":""
        },
        "preSweepIntAccCcy":{
            "type":"number",
            "description":""
        },
        "preSweepIntHeaderCcy":{
            "type":"number",
            "description":""
        },
        "postSweepIntAccCcy":{
            "type":"number",
            "description":""
        },
        "postSweepIntHeaderCcy":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : SweepLogReportBodyDTO

Type: object

Show Source

• fromAccountBal(optional): number
• fromAccountNo(optional): string
• fromAcPostSweepAcBal(optional): number
• fromBranch(optional): string
• fromCcy(optional): string
• logId(optional): string
• prodDesc(optional): string
• sweepDirection(optional): string
• toAccountBal(optional): number
• toAccountNo(optional): string
• toAcPostSweepAcBal(optional): number
• toBranch(optional): string
• toCcy(optional): string
• valueDt(optional): string

{
    "type":"object",
    "properties":{
        "logId":{
            "type":"string",
            "description":""
        },
        "prodDesc":{
            "type":"string",
            "description":""
        },
        "valueDt":{
            "type":"string",
            "description":""
        },
        "fromAccountNo":{
            "type":"string",
            "description":""
        },
        "fromBranch":{
            "type":"string",
            "description":""
        },
        "fromCcy":{
            "type":"string",
            "description":""
        },
        "fromAccountBal":{
            "type":"number",
            "description":""
        },
        "fromAcPostSweepAcBal":{
            "type":"number",
            "description":""
        },
        "toAccountNo":{
            "type":"string",
            "description":""
        },
        "toBranch":{
            "type":"string",
            "description":""
        },
        "toCcy":{
            "type":"string",
            "description":""
        },
        "toAccountBal":{
            "type":"number",
            "description":""
        },
        "toAcPostSweepAcBal":{
            "type":"number",
            "description":""
        },
        "sweepDirection":{
            "type":"string",
            "description":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : SweepSimulateReportDTOCollection

Type: object

Collection of report output.

Show Source

• data(optional): object ReportResponse
  Report Response
• messages(optional): object ResponseDto

{
    "description":"Collection of report output.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ReportResponse"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : ReportResponse

Type: object

Report Response

Show Source

• documentId(optional): string
  Document Id for the document
• documentInbase64(optional): string
  Document in Base64
• reportContentType(optional): string
  Report Content Type for the document

{
    "description":"Report Response",
    "type":"object",
    "properties":{
        "documentId":{
            "description":"Document Id for the document",
            "type":"string"
        },
        "documentInbase64":{
            "description":"Document in Base64",
            "type":"string"
        },
        "reportContentType":{
            "description":"Report Content Type for the document",
            "type":"string"
        }
    }
}

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