Jump to

• Request
• Response

Adds a new exception report data

post

/exceptionReport/save

This endpoint is used to add a new exception report data.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new exception

Root 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created exception

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

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