GET Channels as Select List
Overview
The table below provides key details about the GET
method for listing channels.
Get Channels as Select List | |
---|---|
Method | GET |
URL or Endpoint | /api/v1/projectId/channels/select-list |
Headers | Authorization |
Parameters | projectId |
The description of the URL parameter is as follows:
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
The request does not include request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"canGoLive": false,
"logo": null,
"id": 1400,
"name": "{channelName}",
"value": "{channelId}",
"description": null
},
{
"canGoLive": false,
"logo": null,
"id": 1398,
"name": "{channelName}",
"value": "{channelId}",
"description": null
},
{
"canGoLive": false,
"logo": null,
"id": 1397,
"name": "{channelName}",
"value": "{channelId}",
"description": null
},
{
"canGoLive": false,
"logo": null,
"id": 1396,
"name": "{channelName}",
"value": "{channelId}",
"description": null
},
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
canGoLive | bool | Indicates whether a channel can go live |
logo | string($binary) | Returns the URL for the channel's logo |
name | string | Returns name of the channel |
value | string | Includes a unique identifier associated with the channel |
description | string | Includes a description of the channel |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed