image-by-name.md

Image by Name

image_by_name_controller = client.image_by_name

Class Name

ImageByNameController

Methods

• Get General Image
• Get General Images
• Get Media Info Image
• Get Media Info Images
• Get Rating Image
• Get Rating Images

Get General Image

Get General Image.

def get_general_image(self,
                     name,
                     mtype)

Parameters

Parameter	Type	Tags	Description
name	string	Template, Required	The name of the image.
mtype	string	Template, Required	Image Type (primary, backdrop, logo, etc).

Response Type

mixed

Example Usage

name = 'name0'
mtype = 'type0'

result = image_by_name_controller.get_general_image(name, mtype)

Errors

HTTP Status Code	Error Description	Exception Class
404	Image not found.	ProblemDetailsException

Get General Images

Get all general images.

def get_general_images(self)

Response Type

List of ImageByNameInfo

Example Usage

result = image_by_name_controller.get_general_images()

Errors

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

Get Media Info Image

Get media info image.

def get_media_info_image(self,
                        theme,
                        name)

Parameters

Parameter	Type	Tags	Description
theme	string	Template, Required	The theme to get the image from.
name	string	Template, Required	The name of the image.

Response Type

mixed

Example Usage

theme = 'theme0'
name = 'name0'

result = image_by_name_controller.get_media_info_image(theme, name)

Errors

HTTP Status Code	Error Description	Exception Class
404	Image not found.	ProblemDetailsException

Get Media Info Images

Get all media info images.

def get_media_info_images(self)

Response Type

List of ImageByNameInfo

Example Usage

result = image_by_name_controller.get_media_info_images()

Errors

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

Get Rating Image

Get rating image.

def get_rating_image(self,
                    theme,
                    name)

Parameters

Parameter	Type	Tags	Description
theme	string	Template, Required	The theme to get the image from.
name	string	Template, Required	The name of the image.

Response Type

mixed

Example Usage

theme = 'theme0'
name = 'name0'

result = image_by_name_controller.get_rating_image(theme, name)

Errors

HTTP Status Code	Error Description	Exception Class
404	Image not found.	ProblemDetailsException

Get Rating Images

Get all general images.

def get_rating_images(self)

Response Type

List of ImageByNameInfo

Example Usage

result = image_by_name_controller.get_rating_images()

Errors

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