Skip to main content

GetBoardsResponse

GetBoardsResponse returns the board catalog for the requested scope.

auditData object

Request audit information and downstream trace ids.

requestIdrequestId (string)

Identifier supplied by the caller to correlate the request.

transactions object[]

Downstream transactions performed during the request lifecycle.

  • Array [
    • accessIdaccessId (string)

    Access identifier used for the provider call.

    requestrequest (string)

    Raw request payload captured for auditing.

    responseresponse (string)

    Raw response payload captured for auditing.

    idid (string)

    Identifier of the transaction within the aggregator.

    durationinteger<int32>

    Duration in milliseconds for the provider call.

    httpUrlhttpUrl (string)

    Target URL of the provider call.

    httpStatusCodeinteger<int32>

    HTTP status code returned by the provider.

    httpResponseHeaders object

    HTTP headers returned by the provider.

    property name*value (string)
  • ]
    • errors object[]

    Blocking errors encountered while fetching board data.

  • Array [
    • typetype (string)

    Error type grouping to help the client react appropriately.

    Possible values: [ERR_TYPE_NONE, ERR_TYPE_UNKNOWN, ERR_TYPE_CLIENT, ERR_TYPE_PROVIDER, ERR_TYPE_SERVICE]

    codecode (string)

    Specific error code exposed by the aggregator.

    Possible values: [ERR_CODE_NONE, ERR_CODE_UNKNOWN, ERR_CODE_ACCESS_DATA_MISSING, ERR_CODE_BAD_RESPONSE, ERR_CODE_BAD_REQUEST, ERR_CODE_MISSING_FIELDS, ERR_CODE_CONFIGURATION]

    descriptiondescription (string)

    Human readable description of the error.

    additionalData object

    Additional key/value data associated with the error.

    property name*value (string)
    accessIdaccessId (string)

    Access identifier that produced the error when applicable.

  • ]
    • warnings object[]

    Non-blocking warnings returned alongside the board data.

  • Array [
    • codecode (string)

    Warning code categorising the issue.

    Possible values: [WARN_CODE_NONE, WARN_MAPPING_HOTEL_MISSING, WARN_MAPPING_ROOM_MISSING, WARN_MAPPING_RATE_PLAN_MISSING, WARN_MAPPING_BOARD_CODE_MISSING]

    descriptiondescription (string)

    Human readable warning description.

    additionalData object

    Additional key/value data associated with the warning.

    property name*value (string)
    accessIdaccessId (string)

    Access identifier that produced the warning when available.

  • ]
    • debugData object[]

    Additional debug data for diagnostic purposes.

  • Array [
    • typetype (string)

    Type identifier that categorises the value.

    valuevalue (string)

    Associated value.

  • ]
    • boards object

    Collection of boards that match the request criteria.

    boards object[]

    Boards returned in the current response page.

  • Array [
    • codecode (string)

    Aggregator board identifier.

    boardData object

    Rich metadata describing the board.

    codecode (string)

    Internal code used to identify the board entry.

    boardCodeboardCode (string)

    Provider-specific board code.

    texts object[]

    Localised texts describing the board.

  • Array [
    • texttext (string)

    Translated text value.

    languagelanguage (string)

    ISO 639-1 language code for the text.

  • ]
    • createdAtstring<date-time>

    Creation timestamp for the board entry.

    updatedAtstring<date-time>

    Last update timestamp for the board entry.

  • ]
    • tokentoken (string)

    Pagination token to retrieve the next page of board data.

    GetBoardsResponse
    {
      "auditData": {
        "requestId": "string",
        "transactions": [
          {
            "accessId": "string",
            "request": "string",
            "response": "string",
            "id": "string",
            "duration": 0,
            "httpUrl": "string",
            "httpStatusCode": 0,
            "httpResponseHeaders": {}
          }
        ]
      },
      "errors": [
        {
          "type": "ERR_TYPE_NONE",
          "code": "ERR_CODE_NONE",
          "description": "string",
          "additionalData": {},
          "accessId": "string"
        }
      ],
      "warnings": [
        {
          "code": "WARN_CODE_NONE",
          "description": "string",
          "additionalData": {},
          "accessId": "string"
        }
      ],
      "debugData": [
        {
          "type": "string",
          "value": "string"
        }
      ],
      "boards": {
        "boards": [
          {
            "code": "string",
            "boardData": {
              "code": "string",
              "boardCode": "string",
              "texts": [
                {
                  "text": "string",
                  "language": "string"
                }
              ]
            },
            "createdAt": "2024-07-29T15:51:28.071Z",
            "updatedAt": "2024-07-29T15:51:28.071Z"
          }
        ]
      },
      "token": "string"
    }