Get channel

GET 
/Channels/:channelCode

Get channel

Request

Path Parameters

channelCode stringrequired

The channel code.

Responses

200

The channel with the specified channel code.

application/json

Schema

Schema

channelCode stringnullablerequired

The unique code identifying the transaction channel.

channelTitle stringnullablerequired

The display title of the transaction channel.

createInfo object

Audit metadata capturing who created this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

updateInfo object

Audit metadata capturing who last updated this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

Example (from schema)

{
  "channelCode": "string",
  "channelTitle": "string",
  "createInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  },
  "updateInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  }
}

304

The channel has not changed since the date given in the If-Modified-Since HTTP header.

404

A channel with the specified channel code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...