Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.2 KB

QueueDetailsAPI.md

File metadata and controls

79 lines (51 loc) · 2.2 KB

\QueueDetailsAPI

All URIs are relative to http://localhost:8787

Method HTTP request Description
ListQueueDetails Get /api/v1/queue/details

ListQueueDetails

[]QueueResource ListQueueDetails(ctx).AuthorId(authorId).BookIds(bookIds).IncludeAuthor(includeAuthor).IncludeBook(includeBook).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	authorId := int32(56) // int32 |  (optional)
	bookIds := []int32{int32(123)} // []int32 |  (optional)
	includeAuthor := true // bool |  (optional) (default to false)
	includeBook := true // bool |  (optional) (default to true)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.QueueDetailsAPI.ListQueueDetails(context.Background()).AuthorId(authorId).BookIds(bookIds).IncludeAuthor(includeAuthor).IncludeBook(includeBook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QueueDetailsAPI.ListQueueDetails``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListQueueDetails`: []QueueResource
	fmt.Fprintf(os.Stdout, "Response from `QueueDetailsAPI.ListQueueDetails`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
authorId int32
bookIds []int32
includeAuthor bool [default to false]
includeBook bool [default to true]

Return type

[]QueueResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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