Skip to main content

GET Audio Podcast

Overview


The following table contains information about the GET method in regards to the managing process for retrieving an audio podcast.

GET Audio Podcast
MethodGET
URL or Endpoint/api/v1/projects/projectId/audios/audioId/podcasts
HeadersAuthorization
ParametersaudioId, projectId
BodyNot Applicable

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
audioIdYesstringUnique id of the audio.

Request Body

The GET method doesn't contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"count": 1,
"id": 0,
"name": "{name}",
"value": "{audioId}",
"description": "{description}"
}
],
"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
countinteger($int32)Number of items in the result
idinteger($int32)Unique identifier of the audio
namestringName associated with the audio
valuestringValue associated with the audio
descriptionstringDescription of the audio
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