Skip to content

Latest commit

 

History

History
347 lines (234 loc) · 14.7 KB

SetsAPI.md

File metadata and controls

347 lines (234 loc) · 14.7 KB

\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(ctx, language, game).SortLevel(sortLevel).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).AcceptEncoding(acceptEncoding).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()

List All Sets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	language := "language_example" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	sortLevel := "asc" // string | sort the resulting list by level, default unsorted (optional)
	filterMinHighestEquipmentLevel := int32(190) // int32 | only results where the equipment with the highest level is above or equal to this value (optional)
	filterMaxHighestEquipmentLevel := int32(200) // int32 | only results where the equipment with the highest level is below or equal to this value (optional)
	acceptEncoding := "acceptEncoding_example" // string | optional compression for saving bandwidth (optional)
	filterContainsCosmeticsOnly := true // bool | 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 := true // bool | filter sets based on if they got cosmetic items in it. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SetsAPI.GetAllSetsList(context.Background(), language, game).SortLevel(sortLevel).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).AcceptEncoding(acceptEncoding).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SetsAPI.GetAllSetsList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllSetsList`: ListEquipmentSets
	fmt.Fprintf(os.Stdout, "Response from `SetsAPI.GetAllSetsList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string a valid language code
game string game main 'dofus3' or beta channel 'dofus3beta'

Other Parameters

Other parameters are passed through a pointer to a apiGetAllSetsListRequest struct via the builder pattern

Name Type Description Notes

sortLevel | string | sort the resulting list by level, default unsorted | filterMinHighestEquipmentLevel | int32 | only results where the equipment with the highest level is above or equal to this value | filterMaxHighestEquipmentLevel | int32 | only results where the equipment with the highest level is below or equal to this value | acceptEncoding | string | optional compression for saving bandwidth | filterContainsCosmeticsOnly | bool | 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 | bool | filter sets based on if they got cosmetic items in it. |

Return type

ListEquipmentSets

Authorization

No authorization required

HTTP request headers

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

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

GetSetsList

ListEquipmentSets GetSetsList(ctx, language, game).SortLevel(sortLevel).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).PageSize(pageSize).PageNumber(pageNumber).FieldsSet(fieldsSet).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()

List Sets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	language := "language_example" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	sortLevel := "asc" // string | sort the resulting list by level, default unsorted (optional)
	filterMinHighestEquipmentLevel := int32(190) // int32 | only results where the equipment with the highest level is above or equal to this value (optional)
	filterMaxHighestEquipmentLevel := int32(200) // int32 | only results where the equipment with the highest level is below or equal to this value (optional)
	pageSize := int32(20) // int32 | size of the results from the list. -1 disables pagination and gets all in one response. (optional)
	pageNumber := int32(1) // int32 | 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{"FieldsSet_example"} // []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. (optional)
	filterContainsCosmeticsOnly := true // bool | 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 := true // bool | filter sets based on if they got cosmetic items in it. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SetsAPI.GetSetsList(context.Background(), language, game).SortLevel(sortLevel).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).PageSize(pageSize).PageNumber(pageNumber).FieldsSet(fieldsSet).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SetsAPI.GetSetsList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSetsList`: ListEquipmentSets
	fmt.Fprintf(os.Stdout, "Response from `SetsAPI.GetSetsList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string a valid language code
game string game main 'dofus3' or beta channel 'dofus3beta'

Other Parameters

Other parameters are passed through a pointer to a apiGetSetsListRequest struct via the builder pattern

Name Type Description Notes

sortLevel | string | sort the resulting list by level, default unsorted | filterMinHighestEquipmentLevel | int32 | only results where the equipment with the highest level is above or equal to this value | filterMaxHighestEquipmentLevel | int32 | only results where the equipment with the highest level is below or equal to this value | pageSize | int32 | size of the results from the list. -1 disables pagination and gets all in one response. | pageNumber | int32 | 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 | []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. | filterContainsCosmeticsOnly | bool | 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 | bool | filter sets based on if they got cosmetic items in it. |

Return type

ListEquipmentSets

Authorization

No authorization required

HTTP request headers

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

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

GetSetsSearch

[]ListEquipmentSet GetSetsSearch(ctx, language, game).Query(query).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).Limit(limit).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()

Search Sets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	language := "language_example" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	query := "Des" // string | case sensitive search query
	filterMinHighestEquipmentLevel := int32(195) // int32 | only results where the equipment with the highest level is above or equal to this value (optional)
	filterMaxHighestEquipmentLevel := int32(200) // int32 | only results where the equipment with the highest level is below or equal to this value (optional)
	limit := int32(8) // int32 | maximum number of returned results (optional) (default to 8)
	filterContainsCosmeticsOnly := true // bool | 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 := true // bool | filter sets based on if they got any cosmetic items in it (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SetsAPI.GetSetsSearch(context.Background(), language, game).Query(query).FilterMinHighestEquipmentLevel(filterMinHighestEquipmentLevel).FilterMaxHighestEquipmentLevel(filterMaxHighestEquipmentLevel).Limit(limit).FilterContainsCosmeticsOnly(filterContainsCosmeticsOnly).FilterContainsCosmetics(filterContainsCosmetics).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SetsAPI.GetSetsSearch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSetsSearch`: []ListEquipmentSet
	fmt.Fprintf(os.Stdout, "Response from `SetsAPI.GetSetsSearch`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string a valid language code
game string game main 'dofus3' or beta channel 'dofus3beta'

Other Parameters

Other parameters are passed through a pointer to a apiGetSetsSearchRequest struct via the builder pattern

Name Type Description Notes

query | string | case sensitive search query | filterMinHighestEquipmentLevel | int32 | only results where the equipment with the highest level is above or equal to this value | filterMaxHighestEquipmentLevel | int32 | only results where the equipment with the highest level is below or equal to this value | limit | int32 | maximum number of returned results | [default to 8] filterContainsCosmeticsOnly | bool | 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 | bool | filter sets based on if they got any cosmetic items in it |

Return type

[]ListEquipmentSet

Authorization

No authorization required

HTTP request headers

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

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

GetSetsSingle

EquipmentSet GetSetsSingle(ctx, language, ankamaId, game).Execute()

Single Sets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	language := "language_example" // string | a valid language code
	ankamaId := int32(499) // int32 | identifier
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SetsAPI.GetSetsSingle(context.Background(), language, ankamaId, game).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SetsAPI.GetSetsSingle``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSetsSingle`: EquipmentSet
	fmt.Fprintf(os.Stdout, "Response from `SetsAPI.GetSetsSingle`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string a valid language code
ankamaId int32 identifier
game string game main 'dofus3' or beta channel 'dofus3beta'

Other Parameters

Other parameters are passed through a pointer to a apiGetSetsSingleRequest struct via the builder pattern

Name Type Description Notes

Return type

EquipmentSet

Authorization

No authorization required

HTTP request headers

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

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