CollectionApi.md

\CollectionApi

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

Method	HTTP request	Description
get_collection_by_id	GET /api/v3/collection/{id}
list_collection	GET /api/v3/collection
put_collection	PUT /api/v3/collection
update_collection	PUT /api/v3/collection/{id}

get_collection_by_id

models::CollectionResource get_collection_by_id(id)

Parameters

Name	Type	Description	Required	Notes
id	i32		[required]

Return type

models::CollectionResource

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]

list_collection

Vecmodels::CollectionResource list_collection(tmdb_id)

Parameters

Name	Type	Description	Required	Notes
tmdb_id	Option<i32>

Return type

Vecmodels::CollectionResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

put_collection

put_collection(collection_update_resource)

Parameters

Name	Type	Description	Required	Notes
collection_update_resource	Option<CollectionUpdateResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

update_collection

models::CollectionResource update_collection(id, collection_resource)

Parameters

Name	Type	Description	Required	Notes
id	String		[required]
collection_resource	Option<CollectionResource>

Return type

models::CollectionResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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