ArtistResource
Artists resource
The following resources are applicable:
/artists
Mount Point: /../../../api/v1/artists
GET
Returns an artist list according to search parameters.
STATUS CODES :
200 - OK
Parameters
| name | description | type | default |
|---|---|---|---|
| modifiedSince | timestamp in millisecond after which a modification occured | query | |
| count | the maximum number of artists to be returned | query | |
| startIndex | the start index of the list | query | |
| name | artist's name criteria | query |
Response Body
| element: | artistListResponse |
| media types: | application/xml application/json |
an artist list according to search parameters
POST
Create an artist
STATUS CODES :
200 - The artist was created
400 - There was errors processing the request, the body will contain a message
Request Body
| element: | artist |
| media types: | application/xml application/json |
artist data
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the created artist or a message if the status is not 200
/artists/{artistId}
Mount Point: /../../../api/v1/artists/{artistId}
GET
Gets detailed artist by sowprog id
STATUS CODES :
200 - The artist is returned
404 - The id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| artistId | sowprog artist's id | path |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the detailed artist
PUT
Update an artist.
Only fields that are provided are updated. If a field with an empty value is provided, checks are enforced.
Example : if name is not provided, it will not be updated. If it is provided as an empty value, you will get an error message saying it is mandatory.
STATUS CODES :
200 - The artist was updated
404 - The id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| artistId | sowprog artist's id | path |
Request Body
| element: | artist |
| media types: | application/xml application/json |
artist data
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
the created artist or a message if the status is not 200
/artists/{artistId}/picture
Mount Point: /../../../api/v1/artists/{artistId}/picture
PUT
Defines artist's associated image.
The form must be encoded as a multipart/form-data and the data parameter key must be "file"
STATUS CODES :
200 - The artist is returned
404 - The id does not exist
400 - error processing the file, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| artistId | sowprog artist's id | path | |
| fileInputStream | (no documentation provided) | formdata | |
| contentDispositionHeader | (no documentation provided) | formdata |
Response Body
| element: | artistResponse |
| media types: | application/xml application/json |
(no documentation provided)