Skip to main content

DocumentListResponseWrapper

Response wrapper for credit simulator configuration

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS
messagestring

Message describing the response

Example: Request failed/Request successful
codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001
data object

Represents paginated results.

content object[]

The list of items in the current page.

  • Array [
  • idinteger<int64>

    Unique identifier of the file

    Example: 123
    namestring

    Name of the file

    Example: document.pdf
    sizestring

    Size of the file (human-readable)

    Example: 15MB
    typestring

    MIME type of the file

    Example: application/pdf
    typeIdinteger<int32>

    Type identifier

    Example: 1
    base64Datastring

    Base64 encoded file content

  • ]
  • totalElementsinteger<int64>

    The total number of elements across all pages.

    Example: 100
    totalPagesinteger<int32>

    The total number of pages available.

    Example: 10
    numberinteger<int32>

    The current page number (zero-based).

    Example: 0
    sizeinteger<int32>

    The number of items per page.

    Example: 10
    timestampstring<date-time>

    Timestamp of when the response was generated

    DocumentListResponseWrapper
    {
    "status": "ERROR/SUCCESS",
    "message": "Request failed/Request successful",
    "codeMessage": "ERR-001/SUC-001",
    "data": {
    "content": [
    {
    "id": 123,
    "name": "document.pdf",
    "size": "15MB",
    "type": "application/pdf",
    "typeId": 1,
    "base64Data": "string"
    }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
    },
    "timestamp": "2024-07-29T15:51:28.071Z"
    }