This RFC should be the basis for writing an endpoint for CRUD operations on basket groups following the guidelines.
Actions and routes
The following table presents the proposed routes and actions mappings to be implemented.
| Description |
Action
|
| List basket groups |
GET /acquisitions/basket_groups
|
| Add an basket group |
POST /acquisitions/basket_groups
|
| Get a basket group |
GET /acquisitions/basket_groups/{basket_group_id}
|
| Overwrite a basket group |
PUT /acquisitions/basket_groups/{basket_group_id}
|
| Delete a basket group |
DELETE /acquisitions/basket_groups/{basket_group_id}
|
| Partially update a basket group |
PATCH /acquisitions/basket_groups/{basket_group_id}
|
basket object definition
| DB schema |
Proposed API |
Details
|
| id |
basket_group_id |
Internal identifier for the basket group
|
| name |
name |
Basket group name
|
| closed |
closed |
If the basket group has been closed (BOOLEAN)
|
| booksellerid |
vendor_id |
Internal identifier for the vendor
|
| deliveryplace |
delivery_library_id |
Internal identifier of the delivery library
|
| freedeliveryplace |
delivery_place |
Delivery place (manual entry)
|
| deliverycomment |
delivery_note |
Delivery note
|
| billingplace |
invoice_library_id |
Library to receive bill or invoice for basket, designated by the library internal identifier
|