Skip to content

MetaApi.md

Latest commit

 

History

History
390 lines (296 loc) · 12.3 KB

MetaApi.md

File metadata and controls

390 lines (296 loc) · 12.3 KB

MetaApi

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

Method HTTP request Description
getGameSearchTypes GET /{game}/v1/meta/search/types Available Game Search Types
getItemTypes GET /{game}/v1/meta/items/types Available Item Types
getMetaAlmanaxBonuses GET /dofus3/v1/meta/{language}/almanax/bonuses Available Almanax Bonuses
getMetaAlmanaxBonusesSearch GET /dofus3/v1/meta/{language}/almanax/bonuses/search Search Available Almanax Bonuses
getMetaElements GET /{game}/v1/meta/elements Effects and Condition Elements
getMetaVersion GET /{game}/v1/meta/version Game Version

getGameSearchTypes

List<String> getGameSearchTypes(game)

Available Game Search Types

Get all types for /{game}/v1/{lang}/search available for filtering. All names are english for comparing them inside applications. Order is fixed so you can compare indices instead of strings.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
    try {
      List<String> result = apiInstance.getGameSearchTypes(game);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getGameSearchTypes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
game String game main 'dofus3' or beta channel 'dofus3beta' [enum: dofus3, dofus3beta]

Return type

List<String>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getItemTypes

List<String> getItemTypes(game)

Available Item Types

Get all types of all items. Primarily used for filtering more detailed types in listings or search endpoints. All names are english for comparing them inside applications. Ordering is not guaranteed to persist with game updates.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
    try {
      List<String> result = apiInstance.getItemTypes(game);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getItemTypes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
game String game main 'dofus3' or beta channel 'dofus3beta' [enum: dofus3, dofus3beta]

Return type

List<String>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getMetaAlmanaxBonuses

List<GetMetaAlmanaxBonuses200ResponseInner> getMetaAlmanaxBonuses(language)

Available Almanax Bonuses

Get all the available bonuses and their id for filtering them in the range endpoint.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String language = "en"; // String | a valid language code
    try {
      List<GetMetaAlmanaxBonuses200ResponseInner> result = apiInstance.getMetaAlmanaxBonuses(language);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getMetaAlmanaxBonuses");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
language String a valid language code [enum: en, fr, de, es, pt]

Return type

List<GetMetaAlmanaxBonuses200ResponseInner>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getMetaAlmanaxBonusesSearch

List<GetMetaAlmanaxBonuses200ResponseInner> getMetaAlmanaxBonusesSearch(language, query, limit)

Search Available Almanax Bonuses

Search all the available bonuses and their id for filtering them in the range endpoint.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String language = "en"; // String | a valid language code
    String query = "abond"; // String | case sensitive search query
    Integer limit = 56; // Integer | maximum number of returned results
    try {
      List<GetMetaAlmanaxBonuses200ResponseInner> result = apiInstance.getMetaAlmanaxBonusesSearch(language, query, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getMetaAlmanaxBonusesSearch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
language String a valid language code [enum: en, fr, de, es, pt]
query String case sensitive search query
limit Integer maximum number of returned results [optional]

Return type

List<GetMetaAlmanaxBonuses200ResponseInner>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getMetaElements

List<String> getMetaElements(game)

Effects and Condition Elements

Get the mappings for all specific elements that are linked in the dataset. All names are english. Translations are not needed because of a global unique id which is the index inside the array. Future elements will get a higher id.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
    try {
      List<String> result = apiInstance.getMetaElements(game);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getMetaElements");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
game String game main 'dofus3' or beta channel 'dofus3beta' [enum: dofus3, dofus3beta]

Return type

List<String>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getMetaVersion

Version getMetaVersion(game)

Game Version

The current game version of the hosted data.

Example

// Import classes:
import com.dofusdude.client.ApiClient;
import com.dofusdude.client.ApiException;
import com.dofusdude.client.Configuration;
import com.dofusdude.client.models.*;
import com.dofusdude.client.api.MetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dofusdu.de");

    MetaApi apiInstance = new MetaApi(defaultClient);
    String game = "dofus3"; // String | game main 'dofus3' or beta channel 'dofus3beta'
    try {
      Version result = apiInstance.getMetaVersion(game);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MetaApi#getMetaVersion");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
game String game main 'dofus3' or beta channel 'dofus3beta' [enum: dofus3, dofus3beta]

Return type

Version

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -