embyapi.UserLibraryServiceApi

All URIs are relative to https://home.ourflix.de:32865/emby

Method	HTTP request	Description
delete_users_by_userid_favoriteitems_by_id	DELETE /Users/{UserId}/FavoriteItems/{Id}	Unmarks an item as a favorite
delete_users_by_userid_items_by_id_rating	DELETE /Users/{UserId}/Items/{Id}/Rating	Deletes a user's saved personal rating for an item
get_livetv_programs_by_id	GET /LiveTv/Programs/{Id}	Gets a live tv program
get_users_by_userid_items_by_id	GET /Users/{UserId}/Items/{Id}	Gets an item from a user's library
get_users_by_userid_items_by_id_intros	GET /Users/{UserId}/Items/{Id}/Intros	Gets intros to play before the main media item plays
get_users_by_userid_items_by_id_localtrailers	GET /Users/{UserId}/Items/{Id}/LocalTrailers	Gets local trailers for an item
get_users_by_userid_items_by_id_specialfeatures	GET /Users/{UserId}/Items/{Id}/SpecialFeatures	Gets special features for an item
get_users_by_userid_items_latest	GET /Users/{UserId}/Items/Latest	Gets latest media
get_users_by_userid_items_root	GET /Users/{UserId}/Items/Root	Gets the root folder from a user's library
post_users_by_userid_favoriteitems_by_id	POST /Users/{UserId}/FavoriteItems/{Id}	Marks an item as a favorite
post_users_by_userid_items_by_id_rating	POST /Users/{UserId}/Items/{Id}/Rating	Updates a user's rating for an item

delete_users_by_userid_favoriteitems_by_id

UserItemDataDto delete_users_by_userid_favoriteitems_by_id(user_id, id)

Unmarks an item as a favorite

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Unmarks an item as a favorite
    api_response = api_instance.delete_users_by_userid_favoriteitems_by_id(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->delete_users_by_userid_favoriteitems_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

UserItemDataDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_users_by_userid_items_by_id_rating

UserItemDataDto delete_users_by_userid_items_by_id_rating(user_id, id)

Deletes a user's saved personal rating for an item

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Deletes a user's saved personal rating for an item
    api_response = api_instance.delete_users_by_userid_items_by_id_rating(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->delete_users_by_userid_items_by_id_rating: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

UserItemDataDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_livetv_programs_by_id

BaseItemDto get_livetv_programs_by_id(id)

Gets a live tv program

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
id = 'id_example' # str | Item Id

try:
    # Gets a live tv program
    api_response = api_instance.get_livetv_programs_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_livetv_programs_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Item Id

Return type

BaseItemDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_by_id

BaseItemDto get_users_by_userid_items_by_id(user_id, id)

Gets an item from a user's library

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Gets an item from a user's library
    api_response = api_instance.get_users_by_userid_items_by_id(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

BaseItemDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_by_id_intros

QueryResultBaseItemDto get_users_by_userid_items_by_id_intros(user_id, id)

Gets intros to play before the main media item plays

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Gets intros to play before the main media item plays
    api_response = api_instance.get_users_by_userid_items_by_id_intros(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_by_id_intros: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

QueryResultBaseItemDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_by_id_localtrailers

list[BaseItemDto] get_users_by_userid_items_by_id_localtrailers(user_id, id)

Gets local trailers for an item

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Gets local trailers for an item
    api_response = api_instance.get_users_by_userid_items_by_id_localtrailers(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_by_id_localtrailers: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

list[BaseItemDto]

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_by_id_specialfeatures

list[BaseItemDto] get_users_by_userid_items_by_id_specialfeatures(user_id, id)

Gets special features for an item

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Movie Id

try:
    # Gets special features for an item
    api_response = api_instance.get_users_by_userid_items_by_id_specialfeatures(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_by_id_specialfeatures: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Movie Id

Return type

list[BaseItemDto]

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_latest

list[BaseItemDto] get_users_by_userid_items_latest(user_id, limit=limit, parent_id=parent_id, fields=fields, include_item_types=include_item_types, is_folder=is_folder, is_played=is_played, group_items=group_items, enable_images=enable_images, image_type_limit=image_type_limit, enable_image_types=enable_image_types, enable_user_data=enable_user_data)

Gets latest media

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
limit = 56 # int | Limit (optional)
parent_id = 'parent_id_example' # str | Specify this to localize the search to a specific item or folder. Omit to use the root (optional)
fields = 'fields_example' # str | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, SortName, Studios, Taglines (optional)
include_item_types = 'include_item_types_example' # str | Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted. (optional)
is_folder = true # bool | Filter by items that are folders, or not. (optional)
is_played = true # bool | Filter by items that are played, or not. (optional)
group_items = true # bool | Whether or not to group items into a parent container. (optional)
enable_images = true # bool | Optional, include image information in output (optional)
image_type_limit = 56 # int | Optional, the max number of images to return, per image type (optional)
enable_image_types = 'enable_image_types_example' # str | Optional. The image types to include in the output. (optional)
enable_user_data = true # bool | Optional, include user data (optional)

try:
    # Gets latest media
    api_response = api_instance.get_users_by_userid_items_latest(user_id, limit=limit, parent_id=parent_id, fields=fields, include_item_types=include_item_types, is_folder=is_folder, is_played=is_played, group_items=group_items, enable_images=enable_images, image_type_limit=image_type_limit, enable_image_types=enable_image_types, enable_user_data=enable_user_data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_latest: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
limit	int	Limit	[optional]
parent_id	str	Specify this to localize the search to a specific item or folder. Omit to use the root	[optional]
fields	str	Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, SortName, Studios, Taglines	[optional]
include_item_types	str	Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.	[optional]
is_folder	bool	Filter by items that are folders, or not.	[optional]
is_played	bool	Filter by items that are played, or not.	[optional]
group_items	bool	Whether or not to group items into a parent container.	[optional]
enable_images	bool	Optional, include image information in output	[optional]
image_type_limit	int	Optional, the max number of images to return, per image type	[optional]
enable_image_types	str	Optional. The image types to include in the output.	[optional]
enable_user_data	bool	Optional, include user data	[optional]

Return type

list[BaseItemDto]

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_by_userid_items_root

BaseItemDto get_users_by_userid_items_root(user_id)

Gets the root folder from a user's library

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id

try:
    # Gets the root folder from a user's library
    api_response = api_instance.get_users_by_userid_items_root(user_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->get_users_by_userid_items_root: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id

Return type

BaseItemDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_users_by_userid_favoriteitems_by_id

UserItemDataDto post_users_by_userid_favoriteitems_by_id(user_id, id)

Marks an item as a favorite

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id

try:
    # Marks an item as a favorite
    api_response = api_instance.post_users_by_userid_favoriteitems_by_id(user_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->post_users_by_userid_favoriteitems_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	User Id
id	str	Item Id

Return type

UserItemDataDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_users_by_userid_items_by_id_rating

UserItemDataDto post_users_by_userid_items_by_id_rating(user_id, id, likes)

Updates a user's rating for an item

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserLibraryServiceApi(embyapi.ApiClient(configuration))
user_id = 'user_id_example' # str | User Id
id = 'id_example' # str | Item Id
likes = true # bool | Whether the user likes the item or not. true/false

try:
    # Updates a user's rating for an item
    api_response = api_instance.post_users_by_userid_items_by_id_rating(user_id, id, likes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLibraryServiceApi->post_users_by_userid_items_by_id_rating: %s\n" % e)

Parameters

Name	Type	Description
user_id	str	User Id
id	str	Item Id
likes	bool	Whether the user likes the item or not. true/false

Return type

UserItemDataDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

UserLibraryServiceApi.md

Latest commit

History

UserLibraryServiceApi.md

File metadata and controls

embyapi.UserLibraryServiceApi

delete_users_by_userid_favoriteitems_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

delete_users_by_userid_items_by_id_rating

Example

Parameters

Return type

Authorization

HTTP request headers

get_livetv_programs_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_by_id_intros

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_by_id_localtrailers

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_by_id_specialfeatures

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_latest

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_userid_items_root

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_userid_favoriteitems_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_userid_items_by_id_rating

Example

Parameters

Return type

Authorization

HTTP request headers