Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.51 KB

suggestions.md

File metadata and controls

56 lines (39 loc) · 1.51 KB
Raw

Suggestions

suggestions_controller = client.suggestions

Class Name

SuggestionsController

Get Suggestions

Gets suggestions.

def get_suggestions(self,
                   user_id,
                   media_type=None,
                   mtype=None,
                   start_index=None,
                   limit=None,
                   enable_total_record_count=False)

Parameters

Parameter Type Tags Description
user_id uuid|string Template, Required The user id.
media_type List of string Query, Optional The media types.
mtype List of BaseItemKindEnum Query, Optional The type.
start_index int Query, Optional Optional. The start index.
limit int Query, Optional Optional. The limit.
enable_total_record_count bool Query, Optional Whether to enable the total record count.
Default: False

Response Type

BaseItemDtoQueryResult

Example Usage

user_id = '000013ec-0000-0000-0000-000000000000'
enable_total_record_count = False

result = suggestions_controller.get_suggestions(user_id, None, None, None, None, enable_total_record_count)

Errors

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