GET Videos
Overview
The following table contains information about the GET
method for managing the process that returns all the videos.
GET Videos | |
---|---|
Method | GET |
URL or Endpoint | /api/projects/projectId /videos |
Headers | Authorization |
Parameters | search, page, take, order, insertedDate, projectId |
Body | Not Applicable |
The description of the URL parameter is as follows:
projectId Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
The description of the parameters is as follows:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
search | No | string | Text that is used for filtering. |
page | No | integer($int32) | A specific page with videos. |
take | No | string | Number of videos to take. |
order | No | string | Order by date or not. |
insertedDate | No | Date | Date 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 Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise 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 |
currentPage | integer($int32) | Number of the current page |
totalPages | integer($int32) | Number of the total page |
pageSize | integer($int32) | The size of the page |
totalCount | integer($int32) | Number of the total records |
items | array[string] | Array with records |
title | string | Title of the video |
MediaID | string | Public Id of the video |
thumbnailUrl | string | URL of the thumbnail |
status | string | Status of the record |
publishDate | Date | Date when published |
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