CollectionAPI.md

\CollectionAPI

All URIs are relative to http://localhost:5055/api/v1

Method	HTTP request	Description
GetCollectionByCollectionId	Get /collection/{collectionId}	Get collection details

GetCollectionByCollectionId

Collection GetCollectionByCollectionId(ctx, collectionId).Language(language).Execute()

Get collection details

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	collectionId := float32(537982) // float32 | 
	language := "en" // string |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.CollectionAPI.GetCollectionByCollectionId(context.Background(), collectionId).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CollectionAPI.GetCollectionByCollectionId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCollectionByCollectionId`: Collection
	fmt.Fprintf(os.Stdout, "Response from `CollectionAPI.GetCollectionByCollectionId`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	float32

Other Parameters

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

Name	Type	Description	Notes

language | string | |

Return type

Collection

Authorization

apiKey, cookieAuth

HTTP request headers

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

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