Repository navigation
GetMarketplaceArtist
Walter Lara edited this page Jul 16, 2024
·
2 revisions
Allows to get a single Marketplace Artist.
URL: /v1/marketplace/artists/{artistId}
Method: GET
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
| artistId | string | UUID of the Artist to retrieve. |
Query Parameters: None
Headers:
Accept: application/json
g-recaptcha-platform: {Web|Android|iOS}
g-recaptcha-token: {reCAPTCHA Token for "get_artist" action}
Code: 200 OK
Headers:
Content-Type: application/json
Content:
| Field | Type | Description | Condition |
|---|---|---|---|
| id | string | UUID of the Artist. | Always |
| createdAt | string | Date and time when the Artist was created (ISO-8601 format). | Always |
| name | string | Stage name of the Artist. | Only if available |
| genre | string | Artist genre. | Only if available |
| location | string | Artist location. | Only if available |
| biography | string | Artist biography. | Only if available |
| pictureUrl | string | Valid URL of Artist picture image file. | Only if available |
| websiteUrl | string | Valid URL of Artist personal website. | Only if available |
| twitterUrl | string | Valid URL of Artist Twitter account. | Only if available |
| instagramUrl | string | Valid URL of Artist Instagram account. | Only if available |
| spotifyProfile | string | Spotify artist profile URI. E.g. spotify:artist:xyz for artist link https://open.spotify.com/artist/xyz include. |
Only if available |
| soundCloudProfile | string | SoundCloud artist profile permalink. E,g. xyz for artist link https://soundcloud.com/xyz. |
Only if available |
| appleMusicProfile | string | Apple Music artist profile ID. E,g. xyz for artist link https://music.apple.com/abcd/efg/xyz. |
Only if available |
| releasedSongCount | integer | Number of songs released in NEWM Studio by the Artist. | Always |
| marketplaceSongCount | integer | Number of songs in NEWM Marketplace by the Artist. | Always |
Content example:
{
"id": "7bd2862f-8deb-4814-8943-156d9dab80dd",
"createdAt": "2022-04-22T20:47:55.738918",
"name": "John Doe",
"genre": "Pop",
"location": "USA",
"biography": "John is a leading Pop Music Artist",
"pictureUrl": "https://example.com/john-doe.png",
"websiteUrl": "https://john-doe.com",
"twitterUrl": "https://twitter.com/john-doe",
"instagramUrl": "https://instagram.com/john-doe",
"spotifyProfile": "spotify:artist:john.doe"
"soundCloudProfile": "john.doe",
"appleMusicProfile": "john.doe",
"releasedSongCount": 14,
"marketplaceSongCount": 9
}Code: 403 FORBIDDEN
Condition: If reCAPTCHA fails.
Headers:
Content-Type: application/json
Content example:
{
"code": 403,
"description": "Forbidden",
"cause": "Recaptcha failed"
}Code: 404 NOT FOUND
Condition: If the specified Artist is not found.
Headers:
Content-Type: application/json
Content example:
{
"code": 404,
"description": "Not Found",
"cause": "Entity MarketplaceArtistEntity, id=d0907e3d-a9a7-43b1-93dc-f3b0ee929021 not found in the database"
}Code: 422 UNPROCESSABLE ENTITY
Condition: If {artistId} is malformed.
Headers:
Content-Type: application/json
Content example:
{
"code": 422,
"description": "Unprocessable Entity",
"cause": "Invalid UUID string: 123456789"
}