postItemsRemotesearchMusicalbum
Requires authentication as user
postItemsRemotesearchMusicalbum
Request
post /Items/RemoteSearch/MusicAlbum
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*body | body | RemoteSearchQuery_AlbumInfo | RemoteSearchQuery`1: |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | RemoteSearchResult [] | Operation successful. Returning a List
|
|
400 | Bad Request. Server cannot process request. |
||
401 | Unauthorized. Client needs to authenticate. |
||
403 | Forbidden. No permission for the reqested operation. |
||
404 | Resource not found or unavailable. |
||
500 | Server error. |
Definitions
RemoteSearchQuery_AlbumInfo
RemoteSearchQuery_AlbumInfo
Name | Type | Notes |
---|---|---|
SearchInfo | AlbumInfo[] | |
ItemId | integer (int64) | |
SearchProviderName | string | |
Providers | array | |
IncludeDisabledProviders | boolean |
AlbumInfo
Name | Type | Notes |
---|---|---|
AlbumArtists | array | The album artist. |
SongInfos | SongInfo[] | |
Name | string | The name. |
Path | string | |
MetadataLanguage | string | The metadata language. |
MetadataCountryCode | string | The metadata country code. |
MetadataLanguages | CultureDto[] | |
ProviderIds | ProviderIdDictionary | |
Year | integer (int32) | The year. |
IndexNumber | integer (int32) | |
ParentIndexNumber | integer (int32) | |
PremiereDate | string (date-time) | |
IsAutomated | boolean | |
EnableAdultMetadata | boolean |
SongInfo
Name | Type | Notes |
---|---|---|
AlbumArtists | array | |
Album | string | |
Artists | array | |
Composers | array | |
Name | string | The name. |
Path | string | |
MetadataLanguage | string | The metadata language. |
MetadataCountryCode | string | The metadata country code. |
MetadataLanguages | CultureDto[] | |
ProviderIds | ProviderIdDictionary | |
Year | integer (int32) | The year. |
IndexNumber | integer (int32) | |
ParentIndexNumber | integer (int32) | |
PremiereDate | string (date-time) | |
IsAutomated | boolean | |
EnableAdultMetadata | boolean |
CultureDto
Name | Type | Notes |
---|---|---|
Name | string | The name. |
DisplayName | string | The display name. |
TwoLetterISOLanguageName | string | The name of the two letter ISO language. |
ThreeLetterISOLanguageName | string | The name of the three letter ISO language. |
ThreeLetterISOLanguageNames | array | |
TwoLetterISOLanguageNames | array |
ProviderIdDictionary
RemoteSearchResult
Name | Type | Notes |
---|---|---|
Name | string | The name. |
OriginalTitle | string | |
ProviderIds | ProviderIdDictionary | |
ProductionYear | integer (int32) | The year. |
IndexNumber | integer (int32) | |
IndexNumberEnd | integer (int32) | |
ParentIndexNumber | integer (int32) | |
SortIndexNumber | integer (int32) | |
SortParentIndexNumber | integer (int32) | |
PremiereDate | string (date-time) | |
ImageUrl | string | |
SearchProviderName | string | |
GameSystem | string | |
Overview | string | |
DisambiguationComment | string | |
AlbumArtist | ||
Artists | array |