Skip to main content

GET Videos by PublicId

Overview


The following table contains information about the GET method in regards to the managing process, more precisely when you want to make a GET by using the PublicId.

GET Videos by PublicId
MethodGET
URL or Endpoint/api/projects/projectId/videos/id
HeadersAuthorization
Parametersid, projectId
BodyNot Applicable

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
idYesstringUnique id of the encoded video.

Request Body

The GET method doesn't contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1126,
"publicId": "vjsmxjms",
"name": "string",
"title": "string",
"description": "string",
"publishDate": "2021-07-03T15:45:11.529",
"publishEndDate": "2021-07-03T15:45:11.529",
"publishStatusId": null,
"duration": null,
"entityId": 1086,
"videoPagePermalink": "string",
"userName": null,
"tags": null,
"category": {
"id": 23,
"entityId": 1086,
"categoryId": 11,
"categoryName": "Sports",
"userId": 0
},
"restriction": {
"id": 10,
"entityId": 1086,
"entityRestrictionId": 283146,
"entityRestrictionName": null
},
"adSchedule": {
"id": 4,
"entityId": 1086,
"adScheduleId": 6,
"adScheduleName": "AdSchedule1"
}
},
"resultInfo": null,
"statusCode": 200
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultarray[Object]Returns the response object
idinteger($int32)Unique id of video
publicIdstringThe unique Id of the encoded video
namestringTitle of the video
titlestringTitle of the video
descriptionstringDescription of the video
publishDateDateDate when published
publishEndDateDateDate when end published
publishStatusIdinteger($int32)Id when published
durationinteger($int32)Duration of the video
entityIdinteger($int32)Id of entity
videoPagePermalinkstringPermalink
userNamestringUsername that uploaded video
tagsstringTags of the video
categoryObjectCategory of the video
idinteger($int32)Id of the record
entityIdinteger($int32)Id of entity
categoryIdinteger($int32)Id of the category
categoryNamestringName of the category
userIdinteger($int32)Id of the user
restrictionObjectRestriction object
idinteger($int32)Id of restriction
entityIdinteger($int32)Id of entity
entityRestrictionIdinteger($int32)Id of entity restrictions
entityRestrictionNamestringName of entity restriction
adScheduleObjectAd schedule object
idinteger($int32)Id of record
entityIdinteger($int32)Entity Id
adScheduleIdinteger($int32)Id of ad schedule
adScheduleNamestringName of ad schedule
resultInfostringReturns extra information about the result
statusCodeinteger($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