POST Custom Screen

Overview

---

The table below provides key details about the POST method to create a new Custom Screen.

POST Custom Screen
Method	POST
URL or Endpoint	/api/v1/projectId/custom-screens
Headers	Authorization
Content Type	multipart/form-data
Parameters	projectId
Request Body	Type, SourcePath, File, VideoId, Thumbnail

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 description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
Type	Yes	integer($int32)	Specifies the type of custom screen.
SourcePath	No	string	Indicates the path where the source file is located.
File	Yes	string($binary)	URL of the custom screen file being uploaded.
VideoId	Yes	string	Unique identifier of the video to which the custom screen will be associated.
Thumbnail	No	string($binary)	URL of the thumbnail image for the custom screen.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": 0,
    "type": 1,
    "typeName": "string",
    "source": "string",
    "sourcePath": "string",
    "mimeType": "string",
    "videoId": "string",
    "playBackUrl": "string",
    "thumbnailUrl": "string",
    "channelId": "string",
    "projectId": "string"
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	Returns the unique identifier for the custom screen
type	integer($int32)	Specifies the type of the custom screen.
typeName	string	Name of the type for the custom screen
source	string	The URL to access the custom screen image
sourcePath	string($binary)	The relative path of the source file within the storage system
mimeType	string	The mime type of the custom screen.
videoId	string	The unique identifier of the video associated with the custom screen
playbackUrl	string	The URL for the playback of the video
thumbnailUrl	string	The URL to access the thumbnail image of the custom screen
channelId	string	The unique identifier of the channel associated with the custom screen.
projectId	string	The unique identifier of the project associated with the custom screen.
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