Skip to content

Latest commit

 

History

History
331 lines (218 loc) · 10.9 KB

MountsAPI.md

File metadata and controls

331 lines (218 loc) · 10.9 KB
Raw

\MountsAPI

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

Method HTTP request Description
GetAllMountsList Get /{game}/v1/{language}/mounts/all List All Mounts
GetMountsList Get /{game}/v1/{language}/mounts List Mounts
GetMountsSearch Get /{game}/v1/{language}/mounts/search Search Mounts
GetMountsSingle Get /{game}/v1/{language}/mounts/{ankama_id} Single Mounts

GetAllMountsList

ListMounts GetAllMountsList(ctx, language, game).FilterFamilyName(filterFamilyName).AcceptEncoding(acceptEncoding).FilterFamilyId(filterFamilyId).Execute()

List All Mounts

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'
	filterFamilyName := "Dragoturkey" // string | only results with the translated family name (optional)
	acceptEncoding := "acceptEncoding_example" // string | optional compression for saving bandwidth (optional)
	filterFamilyId := int32(56) // int32 | only results with the unique family id (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MountsAPI.GetAllMountsList(context.Background(), language, game).FilterFamilyName(filterFamilyName).AcceptEncoding(acceptEncoding).FilterFamilyId(filterFamilyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MountsAPI.GetAllMountsList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllMountsList`: ListMounts
	fmt.Fprintf(os.Stdout, "Response from `MountsAPI.GetAllMountsList`: %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 apiGetAllMountsListRequest struct via the builder pattern

Name Type Description Notes

filterFamilyName | string | only results with the translated family name | acceptEncoding | string | optional compression for saving bandwidth | filterFamilyId | int32 | only results with the unique family id |

Return type

ListMounts

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]

GetMountsList

ListMounts GetMountsList(ctx, language, game).FilterFamilyName(filterFamilyName).PageSize(pageSize).PageNumber(pageNumber).FieldsMount(fieldsMount).FilterFamilyId(filterFamilyId).Execute()

List Mounts

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'
	filterFamilyName := "Dragoturkey" // string | only results with the translated family name (optional)
	pageSize := int32(10) // 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)
	fieldsMount := []string{"FieldsMount_example"} // []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. (optional)
	filterFamilyId := int32(56) // int32 | only results with the unique family id (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MountsAPI.GetMountsList(context.Background(), language, game).FilterFamilyName(filterFamilyName).PageSize(pageSize).PageNumber(pageNumber).FieldsMount(fieldsMount).FilterFamilyId(filterFamilyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MountsAPI.GetMountsList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMountsList`: ListMounts
	fmt.Fprintf(os.Stdout, "Response from `MountsAPI.GetMountsList`: %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 apiGetMountsListRequest struct via the builder pattern

Name Type Description Notes

filterFamilyName | string | only results with the translated family name | 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. | fieldsMount | []string | adds fields from their detail endpoint to the item list entries. Multiple comma separated values allowed. | filterFamilyId | int32 | only results with the unique family id |

Return type

ListMounts

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]

GetMountsSearch

[]Mount GetMountsSearch(ctx, language, game).Query(query).FilterFamilyName(filterFamilyName).Limit(limit).FilterFamilyId(filterFamilyId).Execute()

Search Mounts

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'
	query := "Dorée" // string | case sensitive search query
	filterFamilyName := "Dragodinde" // string | only results with the translated family name (optional)
	limit := int32(8) // int32 | maximum number of returned results (optional) (default to 8)
	filterFamilyId := int32(56) // int32 | only results with the unique family id (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MountsAPI.GetMountsSearch(context.Background(), language, game).Query(query).FilterFamilyName(filterFamilyName).Limit(limit).FilterFamilyId(filterFamilyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MountsAPI.GetMountsSearch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMountsSearch`: []Mount
	fmt.Fprintf(os.Stdout, "Response from `MountsAPI.GetMountsSearch`: %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 apiGetMountsSearchRequest struct via the builder pattern

Name Type Description Notes

query | string | case sensitive search query | filterFamilyName | string | only results with the translated family name | limit | int32 | maximum number of returned results | [default to 8] filterFamilyId | int32 | only results with the unique family id |

Return type

[]Mount

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]

GetMountsSingle

Mount GetMountsSingle(ctx, language, ankamaId, game).Execute()

Single Mounts

Example

package main

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

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

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

Name Type Description Notes

Return type

Mount

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]