GET Podcasts with pagination

Overview

---

The following table contains information about the GET method for managing the process of retrieving all podcasts in a list.

GET Podcasts with pagination
Method	GET
URL or Endpoint	/api/v1/projectId/podcasts
Headers	Authorization
Parameters	categoryName, search, order, insertedDate, page, take, 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
categoryName	No	string	Name of category.
search	No	string	Text that is used for filtering.
order	No	string	Specifies the sorting order.
insertedDate	No	string($date-time)	Date when the podcast was inserted.
page	No	integer($int32)	A specific page with podcasts.
take	No	integer($int32)	Number of podcasts to take.

Request Body

This method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 2,
    "pageSize": 10,
    "totalCount": 16,
    "items": [
      {
        "title": "{title}",
        "publicId": "{podcastId}",
        "author": "{author}",
        "publishDate": "2024-04-05T11:42:26.7826159",
        "categoryName": "Arts",
        "thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/podcasts/thumbnails/87818853-8739-4d20-a041-7971b5ac206a.png",
        "canEmbed": true
      },
      {
        "title": "{title}",
        "publicId": "{podcastId}",
        "author": "{author}",
        "publishDate": "2024-04-08T08:29:44.4508549",
        "categoryName": "Arts",
        "thumbnailUrl": "",
        "canEmbed": true
      },
      {
        "title": "{title}",
        "publicId": "{podcastId}",
        "author": "{author}",
        "publishDate": "2024-04-19T12:26:06.0866873",
        "categoryName": "Arts",
        "thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/podcasts/thumbnails/0ca0c734-125e-48c3-aeac-138a6ea6ddec.jpg",
        "canEmbed": true
      }
  
    ]
  },
  "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, it will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	Object	Returns the response object
currentPage	integer($int32)	Number of the current page
totalPages	integer($int32)	Number of the total pages
pageSize	integer($int32)	The size of the page
totalCount	integer($int32)	Number of the total records
items	array[Object]	Array with records
title	string	Title of the podcast
publicId	string	Public Id of podcast
author	string	Author of the podcast
publishDate	Date	Date when podcast is published
categoryName	string	Category of the podcast
thumbnailUrl	string	URL of the podcast's thumbnail
canEmbed	bool	Indicates if the podcast can be embedded
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