Jump to

• Request
• Response

Down load simulation report

get

/service/lmr/simulation/downloadReport

This endpoint is used to down load simulation report.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• structureId(required): string
  structure Id of the report to be downloaded

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

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 : SimulateReportDTOCollection

Type: object

Collection of report output.

Show Source

• data: object ReportResponse
  Report Response
• messages: object ResponseDto
• simulationId: string

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

Nested Schema : ReportResponse

Type: object

Report Response

Show Source

• documentId: string
  Document Id for the document
• documentInbase64: string
  Document in Base64
• reportContentType: 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: 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