Skip to main content

ResponseWrapperPaneSectionMappingListDto

Generic API response wrapper for Pane-Section Mapping List

statusstring

Response status

Possible values: [SUCCESS, ERROR]

Example: SUCCESS
messagestring

Message describing the response

Example: Request successful
codeMessagestring

Code message describing the response

Example: SUC-001
data object[]
  • Array [
  • idstring<uuid>required

    Unique identifier of the pane-section mapping

    Example: 550e8400-e29b-41d4-a716-446655440000
    userIdstring<uuid>required

    Identifier of the user who created the mapping

    Example: 550e8400-e29b-41d4-a716-446655440000
    productCodestringrequired

    Product code (e.g., ILC, ELC)

    Possible values: <= 50 characters

    Example: ILC
    eventCodestringrequired

    Event code (e.g., ISS, AMD)

    Possible values: <= 50 characters

    Example: ISS
    businessApplicationstring[]required

    List of business applications

    Example: ["Adria TSCF Client"]
    customerSegmentstring[]required

    List of customer segments

    Example: ["Corporate"]
    panes object[]required

    Array of pane configurations

  • Array [
  • idstringrequired

    Unique identifier for the pane

    Example: pane-parties
    namestringrequired

    Display name of the pane

    Possible values: <= 255 characters

    Example: Parties
    sequenceinteger<int32>required

    Display order of the pane

    Possible values: >= 1

    Example: 1
    sections object[]required

    Array of section configurations within the pane

    Possible values: >= 1, <= 2147483647

  • Array [
  • idstringrequired

    Unique identifier for the section

    Example: section-applicant
    namestringrequired

    Display name of the section

    Possible values: <= 255 characters

    Example: Applicant Details
    sequenceinteger<int32>required

    Display order of the section within the pane

    Possible values: >= 1

    Example: 1
    rowsinteger<int32>required

    Number of grid rows in the section

    Possible values: >= 1 and <= 20

    Example: 1
    columnsinteger<int32>required

    Number of grid columns in the section

    Possible values: >= 1 and <= 12

    Example: 1
    isRepeatableboolean

    Whether the section can be repeated (for variable-length data)

    Example: false
    groupIdstringnullable

    Group identifier for repeatable sections

    Example: group-beneficiaries
  • ]
  • buttons object[]

    Array of button configurations for the pane

  • Array [
  • idstringrequired

    Unique identifier for the button

    Example: btn-next
    labelstringrequired

    Display label of the button

    Possible values: <= 50 characters

    Example: Next
    positionstringrequired

    Position of the button (left or right)

    Possible values: [left, right]

    Example: right
    variantstringrequired

    Visual variant of the button

    Possible values: [default, secondary, outline, destructive, ghost]

    Example: default
    actionstringrequired

    Action to perform when button is clicked

    Possible values: [next_pane, previous_pane, save_draft, save_template, submit, reject, discard, close, custom]

    Example: next_pane
    targetPaneIdstringnullable

    Target pane ID for custom navigation (when action is 'custom')

    Example: pane-documents
    isVisiblebooleanrequired

    Whether the button is visible

    Example: true
    orderinteger<int32>required

    Display order of the button

    Possible values: >= 1

    Example: 1
  • ]
  • showSwiftPreviewboolean

    Whether to show SWIFT preview for this pane

    Example: false
  • ]
  • isActivebooleanrequired

    Indicates if the mapping is currently active

    Example: true
    createdAtstring<date-time>

    Timestamp when the mapping was created

    Example: 2025-01-15T09:36:22.500Z
    updatedAtstring<date-time>

    Timestamp when the mapping was last updated

    Example: 2025-01-15T09:36:22.500Z
  • ]
  • error objectnullable

    Details of any error that occurred

    codestring

    Error code

    Example: ERR_GENERAL_0004
    messagestring

    Human-readable error message

    Example: The requested resource was not found
    details object[]

    List of error details

  • Array [
  • codestring

    Specific error code

    Example: ER4001
    messagestring

    What went wrong

    Example: Invalid input
    targetstring

    Field that caused the issue

    Example: productCode
  • ]
  • suggestionsstring[]

    Suggested actions to resolve the error

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Additional metadata about the error

    property name*string
    timestampstring<date-time>

    Timestamp of when the response was generated

    Example: 2025-01-15T09:36:22.500Z
    ResponseWrapperPaneSectionMappingListDto
    {
    "status": "SUCCESS",
    "message": "Request successful",
    "codeMessage": "SUC-001",
    "data": [
    {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "productCode": "ILC",
    "eventCode": "ISS",
    "businessApplication": [
    "Adria TSCF Client"
    ],
    "customerSegment": [
    "Corporate"
    ],
    "panes": [
    {
    "id": "pane-parties",
    "name": "Parties",
    "sequence": 1,
    "sections": [
    {
    "id": "section-applicant",
    "name": "Applicant Details",
    "sequence": 1,
    "rows": 1,
    "columns": 1,
    "isRepeatable": false,
    "groupId": "group-beneficiaries"
    }
    ],
    "buttons": [
    {
    "id": "btn-next",
    "label": "Next",
    "position": "right",
    "variant": "default",
    "action": "next_pane",
    "targetPaneId": "pane-documents",
    "isVisible": true,
    "order": 1
    }
    ],
    "showSwiftPreview": false
    }
    ],
    "isActive": true,
    "createdAt": "2025-01-15T09:36:22.500Z",
    "updatedAt": "2025-01-15T09:36:22.500Z"
    }
    ],
    "error": {
    "code": "ERR_GENERAL_0004",
    "message": "The requested resource was not found",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "productCode"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {}
    },
    "timestamp": "2025-01-15T09:36:22.500Z"
    }