Skip to content

Latest commit

 

History

History
341 lines (228 loc) · 12.9 KB

QuestItemsAPI.md

File metadata and controls

341 lines (228 loc) · 12.9 KB

\QuestItemsAPI

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

Method HTTP request Description
GetAllItemsQuestList Get /{game}/v1/{language}/items/quest/all List All Quest Items
GetItemQuestSingle Get /{game}/v1/{language}/items/quest/{ankama_id} Single Quest Items
GetItemsQuestList Get /{game}/v1/{language}/items/quest List Quest Items
GetItemsQuestSearch Get /{game}/v1/{language}/items/quest/search Search Quest Items

GetAllItemsQuestList

ListItems GetAllItemsQuestList(ctx, language, game).SortLevel(sortLevel).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).AcceptEncoding(acceptEncoding).FilterTypeNameId(filterTypeNameId).Execute()

List All Quest Items

Example

package main

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

func main() {
	language := "fr" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	sortLevel := "desc" // string | sort the resulting list by level, default unsorted (optional)
	filterMinLevel := int32(1) // int32 | only results which level is equal or above this value (optional)
	filterMaxLevel := int32(50) // int32 | only results which level is equal or below this value (optional)
	acceptEncoding := "acceptEncoding_example" // string | optional compression for saving bandwidth (optional)
	filterTypeNameId := []string{"Inner_example"} // []string | multi-filter results with the english type name. Add with \"wood\" or \"+wood\" and exclude with \"-wood\". (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.QuestItemsAPI.GetAllItemsQuestList(context.Background(), language, game).SortLevel(sortLevel).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).AcceptEncoding(acceptEncoding).FilterTypeNameId(filterTypeNameId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QuestItemsAPI.GetAllItemsQuestList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllItemsQuestList`: ListItems
	fmt.Fprintf(os.Stdout, "Response from `QuestItemsAPI.GetAllItemsQuestList`: %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 apiGetAllItemsQuestListRequest struct via the builder pattern

Name Type Description Notes

sortLevel | string | sort the resulting list by level, default unsorted | filterMinLevel | int32 | only results which level is equal or above this value | filterMaxLevel | int32 | only results which level is equal or below this value | acceptEncoding | string | optional compression for saving bandwidth | filterTypeNameId | []string | multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood". |

Return type

ListItems

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]

GetItemQuestSingle

Resource GetItemQuestSingle(ctx, language, ankamaId, game).Execute()

Single Quest Items

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.QuestItemsAPI.GetItemQuestSingle(context.Background(), language, ankamaId, game).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QuestItemsAPI.GetItemQuestSingle``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetItemQuestSingle`: Resource
	fmt.Fprintf(os.Stdout, "Response from `QuestItemsAPI.GetItemQuestSingle`: %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 apiGetItemQuestSingleRequest struct via the builder pattern

Name Type Description Notes

Return type

Resource

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]

GetItemsQuestList

ListItems GetItemsQuestList(ctx, language, game).SortLevel(sortLevel).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).PageSize(pageSize).PageNumber(pageNumber).FieldsItem(fieldsItem).FilterTypeNameId(filterTypeNameId).Execute()

List Quest Items

Example

package main

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

func main() {
	language := "fr" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	sortLevel := "desc" // string | sort the resulting list by level, default unsorted (optional)
	filterMinLevel := int32(1) // int32 | only results which level is equal or above this value (optional)
	filterMaxLevel := int32(50) // int32 | only results which level is equal or below this value (optional)
	pageSize := int32(5) // 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)
	fieldsItem := []string{"FieldsItem_example"} // []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. (optional)
	filterTypeNameId := []string{"Inner_example"} // []string | multi-filter results with the english type name. Add with \"wood\" or \"+wood\" and exclude with \"-wood\". (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.QuestItemsAPI.GetItemsQuestList(context.Background(), language, game).SortLevel(sortLevel).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).PageSize(pageSize).PageNumber(pageNumber).FieldsItem(fieldsItem).FilterTypeNameId(filterTypeNameId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QuestItemsAPI.GetItemsQuestList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetItemsQuestList`: ListItems
	fmt.Fprintf(os.Stdout, "Response from `QuestItemsAPI.GetItemsQuestList`: %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 apiGetItemsQuestListRequest struct via the builder pattern

Name Type Description Notes

sortLevel | string | sort the resulting list by level, default unsorted | filterMinLevel | int32 | only results which level is equal or above this value | filterMaxLevel | int32 | only results which level is equal or below 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. | fieldsItem | []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. | filterTypeNameId | []string | multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood". |

Return type

ListItems

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]

GetItemsQuestSearch

[]ListItem GetItemsQuestSearch(ctx, language, game).Query(query).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).Limit(limit).FilterTypeNameId(filterTypeNameId).Execute()

Search Quest Items

Example

package main

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

func main() {
	language := "es" // string | a valid language code
	game := "dofus3" // string | game main 'dofus3' or beta channel 'dofus3beta'
	query := "Ficha" // string | case sensitive search query
	filterMinLevel := int32(60) // int32 | only results which level is equal or above this value (optional)
	filterMaxLevel := int32(70) // int32 | only results which level is equal or below this value (optional)
	limit := int32(8) // int32 | maximum number of returned results (optional) (default to 8)
	filterTypeNameId := []string{"Inner_example"} // []string | multi-filter results with the english type name. Add with \"wood\" or \"+wood\" and exclude with \"-wood\". (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.QuestItemsAPI.GetItemsQuestSearch(context.Background(), language, game).Query(query).FilterMinLevel(filterMinLevel).FilterMaxLevel(filterMaxLevel).Limit(limit).FilterTypeNameId(filterTypeNameId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QuestItemsAPI.GetItemsQuestSearch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetItemsQuestSearch`: []ListItem
	fmt.Fprintf(os.Stdout, "Response from `QuestItemsAPI.GetItemsQuestSearch`: %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 apiGetItemsQuestSearchRequest struct via the builder pattern

Name Type Description Notes

query | string | case sensitive search query | filterMinLevel | int32 | only results which level is equal or above this value | filterMaxLevel | int32 | only results which level is equal or below this value | limit | int32 | maximum number of returned results | [default to 8] filterTypeNameId | []string | multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood". |

Return type

[]ListItem

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]