Skip to main content

GET Videos

Overview


The following table contains information about the GET method for managing the process that returns all the videos.

GET Videos
MethodGET
URL or Endpoint/api/projects/projectId/videos
HeadersAuthorization
Parameterssearch, page, take, order, insertedDate, projectId
BodyNot Applicable

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchNostringText that is used for filtering.
pageNointeger($int32)A specific page with videos.
takeNostringNumber of videos to take.
orderNostringOrder by date or not.
insertedDateNoDateDate when the video was inserted.

Request Body

The GET method doesn't contain a request body.

Response

"success": true,
"errors": [],
"messages": [],
"result": {
"currentPage": 1,
"totalPages": 21,
"pageSize": 10,
"totalCount": 208,
"items": [
{
"title": "{title}",
"MediaID": "{videoId}",
"thumbnailUrl": "",
"status": null,
"publishDate": "2021-06-30T00:00:00"
}
]
},
"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
currentPageinteger($int32)Number of the current page
totalPagesinteger($int32)Number of the total page
pageSizeinteger($int32)The size of the page
totalCountinteger($int32)Number of the total records
itemsarray[string]Array with records
titlestringTitle of the video
MediaIDstringPublic Id of the video
thumbnailUrlstringURL of the thumbnail
statusstringStatus of the record
publishDateDateDate when published
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