item-lookup.md

Item Lookup

item_lookup_controller = client.item_lookup

Class Name

ItemLookupController

Methods

• Apply Search Criteria
• Get Book Remote Search Results
• Get Box Set Remote Search Results
• Get External Id Infos
• Get Movie Remote Search Results
• Get Music Album Remote Search Results
• Get Music Artist Remote Search Results
• Get Music Video Remote Search Results
• Get Person Remote Search Results
• Get Series Remote Search Results
• Get Trailer Remote Search Results

Apply Search Criteria

Applies search criteria to an item and refreshes metadata.

def apply_search_criteria(self,
                         item_id,
                         body,
                         replace_all_images=True)

Parameters

Parameter	Type	Tags	Description
item_id	uuid|string	Template, Required	Item id.
body	RemoteSearchResult	Body, Required	The remote search result.
replace_all_images	bool	Query, Optional	Optional. Whether or not to replace all images. Default: True. Default: True

Response Type

void

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'
body = RemoteSearchResult()
replace_all_images = True

result = item_lookup_controller.apply_search_criteria(item_id, body, replace_all_images)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Book Remote Search Results

Get book remote search.

def get_book_remote_search_results(self,
                                  body)

Parameters

Parameter	Type	Tags	Description
body	BookInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = BookInfoRemoteSearchQuery()

result = item_lookup_controller.get_book_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Box Set Remote Search Results

Get box set remote search.

def get_box_set_remote_search_results(self,
                                     body)

Parameters

Parameter	Type	Tags	Description
body	BoxSetInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = BoxSetInfoRemoteSearchQuery()

result = item_lookup_controller.get_box_set_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get External Id Infos

Get the item's external id info.

def get_external_id_infos(self,
                         item_id)

Parameters

Parameter	Type	Tags	Description
item_id	uuid|string	Template, Required	Item id.

Response Type

List of ExternalIdInfo

Example Usage

item_id = '0000130e-0000-0000-0000-000000000000'

result = item_lookup_controller.get_external_id_infos(item_id)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException
404	Item not found.	ProblemDetailsException

Get Movie Remote Search Results

Get movie remote search.

def get_movie_remote_search_results(self,
                                   body)

Parameters

Parameter	Type	Tags	Description
body	MovieInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = MovieInfoRemoteSearchQuery()

result = item_lookup_controller.get_movie_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Music Album Remote Search Results

Get music album remote search.

def get_music_album_remote_search_results(self,
                                         body)

Parameters

Parameter	Type	Tags	Description
body	AlbumInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = AlbumInfoRemoteSearchQuery()

result = item_lookup_controller.get_music_album_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Music Artist Remote Search Results

Get music artist remote search.

def get_music_artist_remote_search_results(self,
                                          body)

Parameters

Parameter	Type	Tags	Description
body	ArtistInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = ArtistInfoRemoteSearchQuery()

result = item_lookup_controller.get_music_artist_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Music Video Remote Search Results

Get music video remote search.

def get_music_video_remote_search_results(self,
                                         body)

Parameters

Parameter	Type	Tags	Description
body	MusicVideoInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = MusicVideoInfoRemoteSearchQuery()

result = item_lookup_controller.get_music_video_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Person Remote Search Results

Get person remote search.

def get_person_remote_search_results(self,
                                    body)

Parameters

Parameter	Type	Tags	Description
body	PersonLookupInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = PersonLookupInfoRemoteSearchQuery()

result = item_lookup_controller.get_person_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Series Remote Search Results

Get series remote search.

def get_series_remote_search_results(self,
                                    body)

Parameters

Parameter	Type	Tags	Description
body	SeriesInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = SeriesInfoRemoteSearchQuery()

result = item_lookup_controller.get_series_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Trailer Remote Search Results

Get trailer remote search.

def get_trailer_remote_search_results(self,
                                     body)

Parameters

Parameter	Type	Tags	Description
body	TrailerInfoRemoteSearchQuery	Body, Required	Remote search query.

Response Type

List of RemoteSearchResult

Example Usage

body = TrailerInfoRemoteSearchQuery()

result = item_lookup_controller.get_trailer_remote_search_results(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException