Jump to

• Request
• Response

Get exception Report

post

/exceptionReport

This endpoint is used to Get exception Report.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched

Body ()

Request Body that contains data required for fetching exceptions

Root Schema : ExceptionsInDTO

Type: object

Exceptions input DTO

Match All

Show Source

• allOf GenericDto
• object ExceptionsInDTO-allOf[1]

{
    "description":"Exceptions input DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "description":"Structure Id for Exceptions",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "structureType":{
                    "description":"Structure Type for Exceptions",
                    "type":"string"
                },
                "customerId":{
                    "description":"Customer Id for Exceptions",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "fromDate":{
                    "description":"From Date of Exceptions",
                    "type":"string",
                    "format":"date"
                },
                "toDate":{
                    "description":"To Date of Exceptions",
                    "type":"string",
                    "format":"date"
                },
                "eventSource":{
                    "description":"Event Source",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ExceptionsInDTO-allOf[1]

Type: object

Show Source

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

  Customer Id for Exceptions
• eventSource(optional): string
  Event Source
• fromDate(optional): string(date)
  From Date of Exceptions
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  Structure Id for Exceptions
• structureType(optional): string
  Structure Type for Exceptions
• toDate(optional): string(date)
  To Date of Exceptions

{
    "type":"object",
    "properties":{
        "structureId":{
            "description":"Structure Id for Exceptions",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureType":{
            "description":"Structure Type for Exceptions",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id for Exceptions",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "fromDate":{
            "description":"From Date of Exceptions",
            "type":"string",
            "format":"date"
        },
        "toDate":{
            "description":"To Date of Exceptions",
            "type":"string",
            "format":"date"
        },
        "eventSource":{
            "description":"Event Source",
            "type":"string"
        }
    }
}

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

Type: object

Collection of Exceptions

Show Source

• data(optional): object ExceptionDTO
• message(optional): object ResponseDto
• paging(optional): object PagingDto

{
    "description":"Collection of Exceptions",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ExceptionDTO"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "message":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : ExceptionDTO

Type: object

Show Source

• ExceptionReportbodyDTO(optional): array ExceptionReportbodyDTO
• ExceptionReportheaderDTO(optional): object ExceptionReportheaderDTO

{
    "type":"object",
    "properties":{
        "ExceptionReportheaderDTO":{
            "$ref":"#/definitions/ExceptionReportheaderDTO"
        },
        "ExceptionReportbodyDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExceptionReportbodyDTO"
            }
        }
    }
}

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

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : ExceptionReportbodyDTO

Type: array

Show Source

• Array of: object ExceptionReportbodyDTO

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

Nested Schema : ExceptionReportheaderDTO

Type: object

Show Source

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

  Customer Id for Exceptions
• dateAndTime(optional): string
  Generated At time
• fromDate(optional): string(date)
  From Date of Exceptions
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  Structure Id for Exceptions
• structureType(optional): string
  Structure Type for Exceptions
• toDate(optional): string(date)
  To Date of Exceptions
• userId(optional): string
  Generated By user id

{
    "type":"object",
    "properties":{
        "structureId":{
            "description":"Structure Id for Exceptions",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureType":{
            "description":"Structure Type for Exceptions",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id for Exceptions",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "fromDate":{
            "description":"From Date of Exceptions",
            "type":"string",
            "format":"date"
        },
        "toDate":{
            "description":"To Date of Exceptions",
            "type":"string",
            "format":"date"
        },
        "userId":{
            "type":"string",
            "description":"Generated By user id"
        },
        "dateAndTime":{
            "type":"string",
            "description":"Generated At time"
        }
    }
}

Nested Schema : ExceptionReportbodyDTO

Type: object

Show Source

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

  Customer Id for Exceptions
• eventSource(optional): string
  Event Source
• fromAccountNumber(optional): string
  From Account Number for Exceptions
• fromBranchCode(optional): string
  From Branch Code for Exceptions
• fromCurrencyCode(optional): string
  From Currency Code for Exceptions
• logDate(optional): string(date)
• logDescription(optional): string
  Exception occured
• startDate(optional): string(date)
  Start Date for Exceptions
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  Exception occured
• structureType(optional): string
  Structure Type for Exceptions
• toAccountNumber(optional): string
  To Account Number for Exceptions
• toBranchCode(optional): string
  To Branch Code for Exceptions
• toCurrencyCode(optional): string
  To Currency Code for Exceptions
• transactionRef(optional): string
  Transaction Ref for Exceptions
• userId(optional): string
  User Id for Exceptions

{
    "type":"object",
    "properties":{
        "logDate":{
            "type":"string",
            "format":"date"
        },
        "logDescription":{
            "type":"string",
            "description":"Exception occured"
        },
        "structureId":{
            "type":"string",
            "description":"Exception occured",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "startDate":{
            "description":"Start Date for Exceptions",
            "type":"string",
            "format":"date"
        },
        "transactionRef":{
            "description":"Transaction Ref for Exceptions",
            "type":"string"
        },
        "fromAccountNumber":{
            "description":"From Account Number for Exceptions",
            "type":"string"
        },
        "fromBranchCode":{
            "description":"From Branch Code for Exceptions",
            "type":"string"
        },
        "fromCurrencyCode":{
            "description":"From Currency Code for Exceptions",
            "type":"string"
        },
        "toAccountNumber":{
            "description":"To Account Number for Exceptions",
            "type":"string"
        },
        "toBranchCode":{
            "description":"To Branch Code for Exceptions",
            "type":"string"
        },
        "toCurrencyCode":{
            "description":"To Currency Code for Exceptions",
            "type":"string"
        },
        "structureType":{
            "description":"Structure Type for Exceptions",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id for Exceptions",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "userId":{
            "description":"User Id for Exceptions",
            "type":"string"
        },
        "eventSource":{
            "description":"Event Source",
            "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