English

No description in the specification.

8 operations
POST /patron/{patronId}/list CreatePatronList

Create a new patron list

Create a new patron list, the list id is determined by the id in the request. If there exist no patron list with the default ID, the default list can be created.

Parameters

patronIdrequired
path · stringPatron ID from authentication
Shared across operations: version. See the shared contract on the version page.

Request body

application/json · required

CreatePatronListRequestBody

Responses

  • 204 No response body. Success
Error responses: 400 · 401 · 404 — See the shared contract on the version page.
POST /patron/{patronId}/list/{listId} InsertItemToPatronList

Insert an item to a patron list

Insert an item anywhere into the patron list.

Parameters

patronIdrequired
path · stringPatron ID from authentication
listIdrequired
path · stringPatron list ID
position
query · integerUsed to decide where to insert the item, zero based. Default value is 0. If position is greater than the number of items in the list, the item will be added to the end of the list. If position is less than zero, the item will be added to the front of the list. If an item already exists at the position, the new item will be inserted before (at the specified position), and the existing item will be shifted one position down the list.
Shared across operations: version. See the shared contract on the version page.

Request body

application/json · required

AddItemToPatronListRequestBody

Responses

  • 204 No response body. Success
Error responses: 400 · 401 · 404 — See the shared contract on the version page.
DELETE /patron/{patronId}/list/{listId}/item/{itemId} DeletePatronListItem

Delete item from a patron list

Parameters

patronIdrequired
path · stringPatron ID from authentication
listIdrequired
path · stringPatron list ID
itemIdrequired
path · stringItem ID from a patron list
Shared across operations: version. See the shared contract on the version page.

Responses

  • 204 No response body. Success
Error responses: 400 · 401 · 404 — See the shared contract on the version page.
PATCH /patron/{patronId}/list/{listId}/item/{itemId} MovePatronListItem

Move item position on patron list

This moves the item to the specified position on the patron list, the same rules applies here as when inserting an item to a patron list (POST /patron/{patronId}/list/{listId}).

Parameters

patronIdrequired
path · stringPatron ID from authentication
listIdrequired
path · stringPatron list ID
itemIdrequired
path · stringItem ID from a patron list
positionrequired
query · integerUsed to decide where to move an item to, zero based.
Shared across operations: version. See the shared contract on the version page.

Responses

  • 204 No response body. Success
Error responses: 400 · 401 · 404 — See the shared contract on the version page.