GET Player by Pagination

Overview

---

The following table contains important information about the GET method in regards to receiving the players by pagination.

GET Player by Pagination
Method	GET
URL or Endpoint	/api/projects/projectId/players
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate
Body	Not Applicable

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

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	Yes	string	A word you want to filter.
page	Yes	integer($int32)	The page in which the player is located
take	Yes	integer($int32)	The number of players to take from the page
order	Yes	string	The order in which you receive the players.
insertedDate	No	Date	The date

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 6,
    "pageSize": 2,
    "totalCount": 11,
    "items": [
      {
        "publicId": "ptkzupxd",
        "name": "Player i  njomexesd -u",
        "size": "16:9",
        "cloudHostedPlayerLibrary": "https://vp-dev.gjirafa.net/player/ptkzupxd.js",
        "version": "v1.5"
      },
      {
        "publicId": "ptkzupxi",
        "name": "Player with updated config renamed",
        "size": "16:9",
        "cloudHostedPlayerLibrary": "https://vp-dev.gjirafa.net/player/ptkzupxi.js",
        "version": "v1.5"
      }
    ]
  },
  "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[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	Indicates the current page of where the player is located.
totalPages	integer($int32)	The total number of pages.
pageSize	integer($int32)	Indicates how many players are per page.
totalCount	integer($int32)	The total number of players received by the filter.
items	array[Object]	Returns the players on the current page as an array of objects.
publicId	string	The public ID of the player.
name	string	The name of the player.
size	string	The screen ratio of the player.
cloudHostedPlayerLibrary	string	The URL of the cloud hosted player library.
version	string	The version of the player.
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