Skip to content

Latest commit

 

History

History
248 lines (176 loc) · 10.5 KB

SetsApi.md

File metadata and controls

248 lines (176 loc) · 10.5 KB

dofusdude.SetsApi

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

Method HTTP request Description
getAllSetsList GET /{game}/v1/{language}/sets/all List All Sets
getSetsList GET /{game}/v1/{language}/sets List Sets
getSetsSearch GET /{game}/v1/{language}/sets/search Search Sets
getSetsSingle GET /{game}/v1/{language}/sets/{ankama_id} Single Sets

getAllSetsList

ListEquipmentSets getAllSetsList(language, game, opts)

List All Sets

Retrieve all sets 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-js';

let apiInstance = new dofusdude.SetsApi();
let language = "language_example"; // String | a valid language code
let game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
let opts = {
  'sortLevel': "asc", // String | sort the resulting list by level, default unsorted
  'filterMinHighestEquipmentLevel': 190, // Number | only results where the equipment with the highest level is above or equal to this value
  'filterMaxHighestEquipmentLevel': 200, // Number | only results where the equipment with the highest level is below or equal to this value
  'acceptEncoding': "acceptEncoding_example", // String | optional compression for saving bandwidth
  'filterContainsCosmeticsOnly': true, // Boolean | filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment.
  'filterContainsCosmetics': true // Boolean | filter sets based on if they got cosmetic items in it.
};
apiInstance.getAllSetsList(language, game, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
game String game main 'dofus3' or beta channel 'dofus3beta'
sortLevel String sort the resulting list by level, default unsorted [optional]
filterMinHighestEquipmentLevel Number only results where the equipment with the highest level is above or equal to this value [optional]
filterMaxHighestEquipmentLevel Number only results where the equipment with the highest level is below or equal to this value [optional]
acceptEncoding String optional compression for saving bandwidth [optional]
filterContainsCosmeticsOnly Boolean filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment. [optional]
filterContainsCosmetics Boolean filter sets based on if they got cosmetic items in it. [optional]

Return type

ListEquipmentSets

Authorization

No authorization required

HTTP request headers

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

getSetsList

ListEquipmentSets getSetsList(language, game, opts)

List Sets

Retrieve a list of sets.

Example

import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.SetsApi();
let language = "language_example"; // String | a valid language code
let game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
let opts = {
  'sortLevel': "asc", // String | sort the resulting list by level, default unsorted
  'filterMinHighestEquipmentLevel': 190, // Number | only results where the equipment with the highest level is above or equal to this value
  'filterMaxHighestEquipmentLevel': 200, // Number | only results where the equipment with the highest level is below or equal to this value
  'pageSize': 20, // Number | size of the results from the list. -1 disables pagination and gets all in one response.
  'pageNumber': 1, // Number | 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.
  'fieldsSet': ["null"], // [String] | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed.
  'filterContainsCosmeticsOnly': true, // Boolean | filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment.
  'filterContainsCosmetics': true // Boolean | filter sets based on if they got cosmetic items in it.
};
apiInstance.getSetsList(language, game, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
game String game main 'dofus3' or beta channel 'dofus3beta'
sortLevel String sort the resulting list by level, default unsorted [optional]
filterMinHighestEquipmentLevel Number only results where the equipment with the highest level is above or equal to this value [optional]
filterMaxHighestEquipmentLevel Number only results where the equipment with the highest level is below or equal to this value [optional]
pageSize Number size of the results from the list. -1 disables pagination and gets all in one response. [optional]
pageNumber Number 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]
fieldsSet [String] adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. [optional]
filterContainsCosmeticsOnly Boolean filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment. [optional]
filterContainsCosmetics Boolean filter sets based on if they got cosmetic items in it. [optional]

Return type

ListEquipmentSets

Authorization

No authorization required

HTTP request headers

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

getSetsSearch

[ListEquipmentSet] getSetsSearch(language, game, query, opts)

Search Sets

Search in all names and descriptions of sets with a query.

Example

import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.SetsApi();
let language = "language_example"; // String | a valid language code
let game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
let query = "Des"; // String | case sensitive search query
let opts = {
  'filterMinHighestEquipmentLevel': 195, // Number | only results where the equipment with the highest level is above or equal to this value
  'filterMaxHighestEquipmentLevel': 200, // Number | only results where the equipment with the highest level is below or equal to this value
  'limit': 8, // Number | maximum number of returned results
  'filterContainsCosmeticsOnly': true, // Boolean | filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment.
  'filterContainsCosmetics': true // Boolean | filter sets based on if they got any cosmetic items in it
};
apiInstance.getSetsSearch(language, game, query, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
game String game main 'dofus3' or beta channel 'dofus3beta'
query String case sensitive search query
filterMinHighestEquipmentLevel Number only results where the equipment with the highest level is above or equal to this value [optional]
filterMaxHighestEquipmentLevel Number only results where the equipment with the highest level is below or equal to this value [optional]
limit Number maximum number of returned results [optional] [default to 8]
filterContainsCosmeticsOnly Boolean filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment. [optional]
filterContainsCosmetics Boolean filter sets based on if they got any cosmetic items in it [optional]

Return type

[ListEquipmentSet]

Authorization

No authorization required

HTTP request headers

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

getSetsSingle

EquipmentSet getSetsSingle(language, ankamaId, game)

Single Sets

Retrieve a specific set with id.

Example

import dofusdude from 'dofusdude-js';

let apiInstance = new dofusdude.SetsApi();
let language = "language_example"; // String | a valid language code
let ankamaId = 499; // Number | identifier
let game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
apiInstance.getSetsSingle(language, ankamaId, game, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
language String a valid language code
ankamaId Number identifier
game String game main 'dofus3' or beta channel 'dofus3beta'

Return type

EquipmentSet

Authorization

No authorization required

HTTP request headers

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