GET Encoding List Templates
Overview
The following table contains important information about the GET method in regards to retrieve all encoding list templates as select list.
| GET Encoding List Templates Method | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/encoding-templates/select-list |
| Headers | Authorization |
| Parameters | Not applicable |
| Body | Not applicable |
Request Body
The GET request does not have a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"name": "Default Job Template",
"value": "1",
"description": "Default Job template for encoding videos"
},
{
"id": 2,
"name": "DRM Job Template",
"value": "2",
"description": "DRM Job template for encoding videos"
},
{
"id": 3,
"name": "Responsive Size Job Template",
"value": "3",
"description": "Responsive Size Job template for encoding videos"
},
{
"id": 4,
"name": "DRM Template HLS only",
"value": "4",
"description": "DRM Job template for encoding videos with hls outputs"
},
{
"id": 5,
"name": "Transription Job Template",
"value": "5",
"description": "Transription Job Template"
},
{
"id": 6,
"name": "MP4, HLS & MP3 Files Template",
"value": "6",
"description": "Generates MP4, HLS and MP3 Outputs"
},
{
"id": 7,
"name": "Instagram Video Template",
"value": "7",
"description": "Generates MP4 output with a resolution of 1920 x 1080, optimized for high-quality Instagram videos"
}
],
"resultInfo": null,
"statusCode": 200
}
The description to the fields in the code are written in the table below.
| Parameter Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| id | integer | Unique identifier for the job template. |
| name | string | Name of the job template. |
| value | string | The value of the job template. |
| description | string | Description of the job template. |
| 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