Navigation :
Category
GET /v1/entities/category/{entity_id}
Retrieves a specific category.
Request Parameters
Location |
Parameter |
Type |
Required/ Optional |
Description |
path |
entity_id |
string |
optional |
The string id of the category being searched for |
Example Request
GET /v1/entities/category/style HTTP/1.1
Host: api.ampermusic.com
Content-Type: application/vnd.api+json
Authorization: Basic abcxyz
Response Data
Data Item |
Type |
Description |
data |
object |
|
data.attributes |
object |
|
data.attributes.name |
string |
The string name of the category |
data.id |
string |
The string id of the category |
data.links.self |
string |
The URL of the category |
data.links |
object |
|
data.type |
string |
The type of data (entity_category in this case) |
links |
object |
|
links.self |
string |
The URL of this category |
Example Response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Body
{
"data": {
"attributes": {
"name": "Style"
},
"id": "style",
"links": {
"self": "https://api.ampermusic.com/v1/entities/category/style"
},
"type": "entity_category"
},
"links": {
"self": "https://api.ampermusic.com/v1/entities/category/style"
}
}