Skip to content

Latest commit

 

History

History
336 lines (236 loc) · 13.4 KB

CosmeticsApi.md

File metadata and controls

336 lines (236 loc) · 13.4 KB
Raw

dofusdude.CosmeticsApi

All URIs are relative to https://api.dofusdu.de

Method HTTP request Description
get_all_cosmetics_list GET /{game}/{language}/items/cosmetics/all List All Cosmetics
get_cosmetics_list GET /{game}/{language}/items/cosmetics List Cosmetics
get_cosmetics_search GET /{game}/{language}/items/cosmetics/search Search Cosmetics
get_cosmetics_single GET /{game}/{language}/items/cosmetics/{ankama_id} Single Cosmetics

get_all_cosmetics_list

ItemsListPaged get_all_cosmetics_list(language, game, sort_level=sort_level, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, accept_encoding=accept_encoding)

List All Cosmetics

Retrieve all cosmetic items with one request. This endpoint is just an alias for the a list with disabled pagination (page[size]=-1) and all fields[type] set. If you want everything unfiltered, delete the other query parameters. Be careful with testing or (god forbid) using /all in your browser, the returned json is huge and will slow down the browser! Tip: set the HTTP Header 'Accept-Encoding: gzip' for saving bandwidth. You will need to uncompress it on your end. Example with cURL: curl -sH 'Accept-Encoding: gzip' <api-endpoint> | gunzip -

Example

import dofusdude
from dofusdude.models.items_list_paged import ItemsListPaged
from dofusdude.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dofusdu.de
# See configuration.py for a list of all supported configuration parameters.
configuration = dofusdude.Configuration(
    host = "https://api.dofusdu.de"
)


# Enter a context with an instance of the API client
with dofusdude.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dofusdude.CosmeticsApi(api_client)
    language = 'fr' # str | a valid language code
    game = 'dofus2' # str | 
    sort_level = 'asc' # str | sort the resulting list by level, default unsorted (optional)
    filter_type_name = 'Chapeau d'apparat' # str | only results with the translated type name (optional)
    filter_min_level = 1 # int | only results which level is equal or above this value (optional)
    filter_max_level = 5 # int | only results which level is equal or below this value (optional)
    accept_encoding = 'accept_encoding_example' # str | optional compression for saving bandwidth (optional)

    try:
        # List All Cosmetics
        api_response = api_instance.get_all_cosmetics_list(language, game, sort_level=sort_level, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, accept_encoding=accept_encoding)
        print("The response of CosmeticsApi->get_all_cosmetics_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CosmeticsApi->get_all_cosmetics_list: %s\n" % e)

Parameters

Name Type Description Notes
language str a valid language code
game str
sort_level str sort the resulting list by level, default unsorted [optional]
filter_type_name str only results with the translated type name [optional]
filter_min_level int only results which level is equal or above this value [optional]
filter_max_level int only results which level is equal or below this value [optional]
accept_encoding str optional compression for saving bandwidth [optional]

Return type

ItemsListPaged

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Cosmetics Found -
400 Bad Request -
404 Not Found -

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

get_cosmetics_list

ItemsListPaged get_cosmetics_list(language, game, sort_level=sort_level, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, page_size=page_size, page_number=page_number, fields_item=fields_item)

List Cosmetics

Retrieve a list of cosmetic items.

Example

import dofusdude
from dofusdude.models.items_list_paged import ItemsListPaged
from dofusdude.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dofusdu.de
# See configuration.py for a list of all supported configuration parameters.
configuration = dofusdude.Configuration(
    host = "https://api.dofusdu.de"
)


# Enter a context with an instance of the API client
with dofusdude.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dofusdude.CosmeticsApi(api_client)
    language = 'fr' # str | a valid language code
    game = 'dofus2' # str | 
    sort_level = 'asc' # str | sort the resulting list by level, default unsorted (optional)
    filter_type_name = 'Chapeau d'apparat' # str | only results with the translated type name (optional)
    filter_min_level = 1 # int | only results which level is equal or above this value (optional)
    filter_max_level = 5 # int | only results which level is equal or below this value (optional)
    page_size = 5 # int | size of the results from the list. -1 disables pagination and gets all in one response. (optional)
    page_number = 1 # int | page number based on the current page[size]. So you could get page 1 with 8 entrys and page 2 would have entries 8 to 16. (optional)
    fields_item = ['[\"recipe\"]'] # List[str] | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. (optional)

    try:
        # List Cosmetics
        api_response = api_instance.get_cosmetics_list(language, game, sort_level=sort_level, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, page_size=page_size, page_number=page_number, fields_item=fields_item)
        print("The response of CosmeticsApi->get_cosmetics_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CosmeticsApi->get_cosmetics_list: %s\n" % e)

Parameters

Name Type Description Notes
language str a valid language code
game str
sort_level str sort the resulting list by level, default unsorted [optional]
filter_type_name str only results with the translated type name [optional]
filter_min_level int only results which level is equal or above this value [optional]
filter_max_level int only results which level is equal or below this value [optional]
page_size int size of the results from the list. -1 disables pagination and gets all in one response. [optional]
page_number int page number based on the current page[size]. So you could get page 1 with 8 entrys and page 2 would have entries 8 to 16. [optional]
fields_item List[str] adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. [optional]

Return type

ItemsListPaged

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Cosmetics Found -
400 Bad Request -
404 Not Found -

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

get_cosmetics_search

List[ItemListEntry] get_cosmetics_search(language, game, query, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, limit=limit)

Search Cosmetics

Search in all names and descriptions of cosmetic items with a query.

Example

import dofusdude
from dofusdude.models.item_list_entry import ItemListEntry
from dofusdude.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dofusdu.de
# See configuration.py for a list of all supported configuration parameters.
configuration = dofusdude.Configuration(
    host = "https://api.dofusdu.de"
)


# Enter a context with an instance of the API client
with dofusdude.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dofusdude.CosmeticsApi(api_client)
    language = 'language_example' # str | a valid language code
    game = 'dofus2' # str | 
    query = 'nedora' # str | case sensitive search query
    filter_type_name = 'Costume' # str | only results with the translated type name (optional)
    filter_min_level = 1 # int | only results which level is equal or above this value (optional)
    filter_max_level = 2 # int | only results which level is equal or below this value (optional)
    limit = 8 # int | maximum number of returned results (optional) (default to 8)

    try:
        # Search Cosmetics
        api_response = api_instance.get_cosmetics_search(language, game, query, filter_type_name=filter_type_name, filter_min_level=filter_min_level, filter_max_level=filter_max_level, limit=limit)
        print("The response of CosmeticsApi->get_cosmetics_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CosmeticsApi->get_cosmetics_search: %s\n" % e)

Parameters

Name Type Description Notes
language str a valid language code
game str
query str case sensitive search query
filter_type_name str only results with the translated type name [optional]
filter_min_level int only results which level is equal or above this value [optional]
filter_max_level int only results which level is equal or below this value [optional]
limit int maximum number of returned results [optional] [default to 8]

Return type

List[ItemListEntry]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Cosmetics found -
400 Bad Request Possibilities: - empty or no query -
404 Not Found Possibilities: - no hits for query -

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

get_cosmetics_single

Cosmetic get_cosmetics_single(language, ankama_id, game)

Single Cosmetics

Retrieve a specific cosmetic item with id.

Example

import dofusdude
from dofusdude.models.cosmetic import Cosmetic
from dofusdude.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dofusdu.de
# See configuration.py for a list of all supported configuration parameters.
configuration = dofusdude.Configuration(
    host = "https://api.dofusdu.de"
)


# Enter a context with an instance of the API client
with dofusdude.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dofusdude.CosmeticsApi(api_client)
    language = 'language_example' # str | a valid language code
    ankama_id = 24132 # int | identifier
    game = 'dofus2' # str | 

    try:
        # Single Cosmetics
        api_response = api_instance.get_cosmetics_single(language, ankama_id, game)
        print("The response of CosmeticsApi->get_cosmetics_single:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CosmeticsApi->get_cosmetics_single: %s\n" % e)

Parameters

Name Type Description Notes
language str a valid language code
ankama_id int identifier
game str

Return type

Cosmetic

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Cosmetic Found -
400 Bad Request Possibilities: - invalid ankama id format -
404 Not Found Possibilities: - nothing found for this ankama_id -

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