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 | |
---|---|
Method | GET |
URL or Endpoint | /api/v1/projectId /audios/audioId /podcasts |
Headers | Authorization |
Parameters | audioId, projectId |
Body | Not Applicable |
The description of the URL parameter is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | Unique Id of the project. |
audioId | Yes | string | Unique 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 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 |
count | integer($int32) | Number of items in the result |
id | integer($int32) | Unique identifier of the audio |
name | string | Name associated with the audio |
value | string | Value associated with the audio |
description | string | Description of the audio |
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