Skip to content

Latest commit

 

History

History
165 lines (108 loc) · 4.86 KB

AlmanaxAPI.md

File metadata and controls

165 lines (108 loc) · 4.86 KB

\AlmanaxAPI

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

Method HTTP request Description
GetAlmanaxDate Get /dofus2/{language}/almanax/{date} Single Almanax Date
GetAlmanaxRange Get /dofus2/{language}/almanax Almanax Range

GetAlmanaxDate

AlmanaxEntry GetAlmanaxDate(ctx, language, date).Execute()

Single Almanax Date

Example

package main

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

func main() {
	language := "fr" // string | code
	date := time.Now() // string | yyyy-mm-dd

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string code
date string yyyy-mm-dd

Other Parameters

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

Name Type Description Notes

Return type

AlmanaxEntry

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]

GetAlmanaxRange

[]AlmanaxEntry GetAlmanaxRange(ctx, language).FilterBonusType(filterBonusType).RangeFrom(rangeFrom).RangeTo(rangeTo).RangeSize(rangeSize).Timezone(timezone).Execute()

Almanax Range

Example

package main

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

func main() {
	language := "fr" // string | code
	filterBonusType := "experience-points" // string | ids from meta/{language}/almanax/bonuses (optional)
	rangeFrom := time.Now() // string | yyyy-mm-dd (optional)
	rangeTo := time.Now() // string | yyyy-mm-dd (optional)
	rangeSize := int32(-1) // int32 | size of the returned range (optional)
	timezone := "Europe/Paris" // string | determine what the current time is. If you live in Brazil, \"today\" will be hours apart from Paris. Use your timezone to get results relative to your location. (optional) (default to "Europe/Paris")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AlmanaxAPI.GetAlmanaxRange(context.Background(), language).FilterBonusType(filterBonusType).RangeFrom(rangeFrom).RangeTo(rangeTo).RangeSize(rangeSize).Timezone(timezone).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AlmanaxAPI.GetAlmanaxRange``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAlmanaxRange`: []AlmanaxEntry
	fmt.Fprintf(os.Stdout, "Response from `AlmanaxAPI.GetAlmanaxRange`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
language string code

Other Parameters

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

Name Type Description Notes

filterBonusType | string | ids from meta/{language}/almanax/bonuses | rangeFrom | string | yyyy-mm-dd | rangeTo | string | yyyy-mm-dd | rangeSize | int32 | size of the returned range | timezone | string | determine what the current time is. If you live in Brazil, "today" will be hours apart from Paris. Use your timezone to get results relative to your location. | [default to "Europe/Paris"]

Return type

[]AlmanaxEntry

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]