| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | mod-orders | |||||||||||||||||||||||||
2 | Method | Path | Request | Response | Description | Usage | ||||||||||||||||||||
3 | POST | /orders/composite-orders | composite_purchase_order | composite_purchase_order | Create a new order w/ or w/o po_lines | ui-orders: new purchase_order, mod-gobi: order placement | ||||||||||||||||||||
4 | GET | /orders/composite-orders | CQL query arg | purchase_order_collection | Search/List purchase_orders | ui-orders: main listing of orders w/ search and filtering | NOTE: renamed schema for consistency | |||||||||||||||||||
5 | GET | /orders/composite-orders/<id> | N/A | composite_purchase_order | Get all information about this order | ui-orders: when row is selected from main listing | ||||||||||||||||||||
6 | PUT | /orders/composite-orders/<id> | composite_purchase_order | 204 | Edit this order w/ or w/o po_lines | ui-orders: edit purchase_order | ||||||||||||||||||||
7 | DELETE | /orders/composite-orders/<id> | N/A | 204 | Delete this order and all related data | ui-orders: remove purchase_order | ||||||||||||||||||||
8 | POST | /orders/order-lines | composite_po_line | composite_po_line | Add a po_line to this order | ui-orders: new po_line | ||||||||||||||||||||
9 | GET | /orders/order-lines | CQL query arg | po_line_collection | Search/List po_lines | ui-orders: display order details, ui-orders: display po_lines for this order (filtered by status) | NOTE: renamed schema for consistency | |||||||||||||||||||
10 | GET | /orders/order-lines/<id> | N/A | composite_po_line | Get this po_line and related sub-objects | ui-orders: display po_line details, ui-inventory: get orders data related to an item/holding/instance | NOTE: this functionality is needed to integrate w/ inventory | |||||||||||||||||||
11 | PUT | /orders/order-lines/<id> | composite_po_line | 204 | Edit this po_line or related sub-objects | ui-orders: edit a po_line | ||||||||||||||||||||
12 | DELETE | /orders/order-lines/<id> | N/A | 204 | Delete this po_line and all related data | ui-orders: delete a po_line | ||||||||||||||||||||
13 | POST | /orders/receive | receiving_collection | receiving_collection | Receive items spanning one or more po_lines in this order | ui-orders: receiving modal | ||||||||||||||||||||
14 | POST | /orders/check-in | checkin_collection | checkin_collection | Check-in items spanning one or more po_lines in this order | ui-orders: check-in modal | ||||||||||||||||||||
15 | GET | /orders/receiving-history | CQL query arg | receiving_history_collection | Get receiveing history matching the provided criteria | ui-receiving: main listing of receiving history w/ search and filtering | ||||||||||||||||||||
16 | GET | /orders/po-number | N/A | po_number | Get an auto-generated po_number (with optional prefix?) | ui-orders: new purchase_order | ||||||||||||||||||||
17 | POST | /orders/po-number/validate | po_number | 204/400 | Check if the provided po_number is valid and unique | ui-orders: new purchase_order | ||||||||||||||||||||
18 | POST | /orders/pieces | piece | piece | Add a piece to a check-in order | ui-orders: check-in modal (add piece) | ||||||||||||||||||||
19 | PUT | /orders/peices/<id> | piece | 204 | Update piece by id | ui-orders: check-in modal (edit piece) | ||||||||||||||||||||
20 | DELETE | /orders/peices/<id> | N/A | 204 | Delete piece by id | ui-orders: check-in modal (remove piece) | ||||||||||||||||||||
21 | POST | /acquisitions-units/units | acquisitions_unit | acquisitions_unit | Create acquisitions_unit | https://issues.folio.org/browse/MODORDERS-249 | ||||||||||||||||||||
22 | GET | /acquisitions-units/units | CQL query arg | acquisitions_unit_collection | Search/List acquisitions_units | |||||||||||||||||||||
23 | GET | /acquisitions-units/units/<id> | N/A | acquisitions_unit | Get acquisitions_unit by id | |||||||||||||||||||||
24 | PUT | /acquisitions-units/units/<id> | acquisitions_unit | 204 | Update acquisitions_unit by id | |||||||||||||||||||||
25 | DELETE | /acquisitions-units/units/<id> | N/A | 204 | Update acquisitions unit by id setting the "isDeleted" field to true | |||||||||||||||||||||
26 | POST | /acquisitions-units/memberships | membership | membership | Create acquisitions_unit membership | https://issues.folio.org/browse/MODORDERS-250 | ||||||||||||||||||||
27 | GET | /acquisitions-units/memberships | CQL query arg | membership_collection | Search/List acquisitions_units membership | |||||||||||||||||||||
28 | GET | /acquisitions-units/memberships/<id> | N/A | membership | Get acquisitions_unit membership by id | |||||||||||||||||||||
29 | PUT | /acquisitions-units/memberships/<id> | membership | 204 | Update acquisitions_unit membership by id | |||||||||||||||||||||
30 | DELETE | /acquisitions-units/memberships/<id> | N/A | 204 | Delete acquisitions_unit membership by id | |||||||||||||||||||||
31 | POST | /orders/acquisitions-unit-assignments | assignment | assignment | Create acquisitions_unit assignment | https://issues.folio.org/browse/MODORDERS-266 | ||||||||||||||||||||
32 | GET | /orders/acquisitions-unit-assignments | CQL query arg | assignment_collection | Search/List acquisitions_units assignment | |||||||||||||||||||||
33 | GET | /orders/acquisitions-unit-assignments/<id> | N/A | assignment | Get acquisitions_unit assignment by id | |||||||||||||||||||||
34 | PUT | /orders/acquisitions-unit-assignments/<id> | assignment | assignment | Update acquisitions_unit assignment by id | |||||||||||||||||||||
35 | DELETE | /orders/acquisitions-unit-assignments/<id> | N/A | 204 | Delete acquisitions_unit assignment by id | |||||||||||||||||||||
36 | POST | /orders/order-templates | order_template | order_template | Create order template | https://issues.folio.org/browse/MODORDSTOR-107 | ||||||||||||||||||||
37 | GET | /orders/order-templates | CQL query arg | order_template_collection | Search/List order templates | |||||||||||||||||||||
38 | GET | /orders/order-templates/<id> | N/A | order_template | Getorder template by id | |||||||||||||||||||||
39 | PUT | /orders/order-templates/<id> | order_template | 204 | Update order template by id | |||||||||||||||||||||
40 | DELETE | /orders/order-templates/<id> | N/A | 204 | Delete order template by id | |||||||||||||||||||||
41 | ||||||||||||||||||||||||||
42 | mod-orders-storage | |||||||||||||||||||||||||
43 | Method | Path | Request | Response | Description | Usage | ||||||||||||||||||||
44 | POST | /orders-storage/purchase-orders | purchase_order | purchase_order | Create purchase_order | mod-orders: POST/orders/composite-orders | ||||||||||||||||||||
45 | GET | /orders-storage/purchase-orders | CQL query arg | purchase_order_collection | Search/List purchase_orders | mod-orders: POST /po-number/validate | ||||||||||||||||||||
46 | GET | /orders-storage/purchase-orders/<id> | N/A | purchase_order | Get purchase_order by id | mod-orders: GET /orders/composite-orders/<id> | ||||||||||||||||||||
47 | PUT | /orders-storage/purchase-orders/<id> | purchase_order | 204 | Update purchase_order by id | mod-orders: PUT /orders/composite-orders/<id> | ||||||||||||||||||||
48 | DELETE | /orders-storage/purchase-orders/<id> | N/A | 204 | Delete purchase order by id | mod-orders: DELETE /orders/composite-orders/<id> | ||||||||||||||||||||
49 | POST | /orders-storage/po-lines | po_line | po_line | Create po_line | mod-orders: POST /orders, mod-orders: POST /orders/order-lines | NOTE: po_line now includes: adjustments, claims, cost, detail, eresource, fund_distribution, license, location, physical, source, vendor_detail | |||||||||||||||||||
50 | GET | /orders-storage/po-lines | CQL query arg | po_line_collection | Search/List po_lines | mod-orders: GET /orders/composite-orders/<id>/order-lines | ||||||||||||||||||||
51 | GET | /orders-storage/po-lines/<id> | N/A | po_line | Get po_line by id | mod-orders: GET /orders/order-lines/<id> | ||||||||||||||||||||
52 | PUT | /orders-storage/po-lines/<id> | po_line | 204 | Update po_line by id | mod-orders: PUT /orders/order-lines/<id>, mod-orders: PUT /orders/id | ||||||||||||||||||||
53 | DELETE | /orders-storage/po-lines/<id> | N/A | 204 | Delete po_line by id | mod-orders: DELETE /orders/order-lines/<id> | ||||||||||||||||||||
54 | POST | /orders-storage/peices | piece | piece | Create piece | mod-orders: POST /orders/receive, mod-orders: POST /orders/check-in | ||||||||||||||||||||
55 | GET | /orders-storage/peices | CQL query arg | piece_collection | Search/List pieces | mod-orders: POST /orders/receive, mod-orders: POST /orders/check-in | ||||||||||||||||||||
56 | GET | /orders-storage/peices/<id> | N/A | piece | Get piece by id | mod-orders: POST /orders/receive, mod-orders: POST /orders/check-in | ||||||||||||||||||||
57 | PUT | /orders-storage/peices/<id> | piece | 204 | Update piece by id | mod-orders: POST /orders/receive, mod-orders: POST /orders/check-in | ||||||||||||||||||||
58 | DELETE | /orders-storage/peices/<id> | N/A | 204 | Delete piece by id | mod-orders: ??? | Would we remove piece records if order or line are removed? | |||||||||||||||||||
59 | POST | /orders-storage/alerts | alert | alert | Create alert | mod-orders: ??? | Are reporting_codes something we can store in mod-configuration? | |||||||||||||||||||
60 | GET | /orders-storage/alerts | CQL query arg | alert_collection | Search/List alerts | mod-orders: ??? | ||||||||||||||||||||
61 | GET | /orders-storage/alerts/<id> | N/A | alert | Get alert by id | mod-orders: ??? | ||||||||||||||||||||
62 | PUT | /orders-storage/alerts/<id> | alert | 204 | Update alert by id | mod-orders: ??? | ||||||||||||||||||||
63 | DELETE | /orders-storage/alerts/<id> | N/A | 204 | Delete alert by id | mod-orders: ??? | ||||||||||||||||||||
64 | POST | /orders-storage/reporting-codes | reporting_code | reporting_code | Create reporting_codes | mod-orders: ??? | ||||||||||||||||||||
65 | GET | /orders-storage/reporting-codes | CQL query arg | reporting_code_collection | Search/List reporting_codes | mod-orders: ??? | ||||||||||||||||||||
66 | GET | /orders-storage/reporting-codes/<id> | N/A | reporting_code | Get reporting_code by id | mod-orders: ??? | ||||||||||||||||||||
67 | PUT | /orders-storage/reporting-codes/<id> | reporting_code | 204 | Update reporting_code by id | mod-orders: ??? | ||||||||||||||||||||
68 | DELETE | /orders-storage/reporting-codes/<id> | N/A | 204 | Delete reporting_code by id | mod-orders: ??? | ||||||||||||||||||||
69 | GET | /orders-storage/orders | CQL query arg | purchase_order_collection | For querying a view combining purchase_orders, po_lines, etc. | mod-orders: GET /orders/composite-orders | ||||||||||||||||||||
70 | GET | /orders-storage/order-lines | CQL query arg | po_line_collection | For querying a view combining purchase_orders, po_lines, etc. | mod-orders: GET /orders/order-lines | ||||||||||||||||||||
71 | GET | /orders-storage/receiving-history | CQL query arg | receiving_history_collection | For querying a view combining po_lines, pieces, etc. | mod-orders: GET /orders/receiving-history | ||||||||||||||||||||
72 | GET | /orders-storage/po-number | N/A | sequence_number | Get the next value in the po_number sequence | mod-orders: GET /orders/po-number | ||||||||||||||||||||
73 | GET | /orders-storage/po-line-number | purchaseOrderId query arg | sequence_number | Get the next value in the PO's po_line_number sequence | mod-orders: POST /orders, mod-orders: PUT /orders, mod-orders: POST /orders/lines, mod-orders: PUT /orders/lines/<id> | ||||||||||||||||||||
74 | POST | /order-storage/order-invoice-relns | order_invoice_relationship | order_invoice_relationship | Create an order_invoice_relationship | https://issues.folio.org/browse/MODORDSTOR-80 | ||||||||||||||||||||
75 | GET | /order-storage/order-invoice-relns | CQL query arg | order_invoice_relationship_collection | Search/List order_invoice_relationship | |||||||||||||||||||||
76 | GET | /order-storage/order-invoice-relns/<id> | NA | order_invoice_relationship | Get an order_invoice_relationship by ID | |||||||||||||||||||||
77 | PUT | /order-storage/order-invoice-relns/<id> | order_invoice_relationship | 204 | Edit an order_invoice_relationship | |||||||||||||||||||||
78 | DELETE | /order-storage/order-invoice-relns/<id> | NA | 204 | Delete an order_invoice_relationship | |||||||||||||||||||||
79 | POST | /acquisitions-units-storage/units | acquisitions_unit | acquisitions_unit | Create acquisitions_unit | https://issues.folio.org/browse/MODORDSTOR-82 | ||||||||||||||||||||
80 | GET | /acquisitions-units-storage/units | CQL query arg | acquisitions_unit_collection | Search/List acquisitions_units | |||||||||||||||||||||
81 | GET | /acquisitions-units-storage/units/<id> | N/A | acquisitions_unit | Get acquisitions_unit by id | |||||||||||||||||||||
82 | PUT | /acquisitions-units-storage/units/<id> | acquisitions_unit | 204 | Update acquisitions_unit by id | |||||||||||||||||||||
83 | DELETE | /acquisitions-units-storage/units/<id> | N/A | 204 | Delete acquisitions_unit by id | |||||||||||||||||||||
84 | POST | /acquisitions-units-storage/memberships | membership | membership | Create acquisitions_unit membership | https://issues.folio.org/browse/MODORDSTOR-83 | ||||||||||||||||||||
85 | GET | /acquisitions-units-storage/memberships | CQL query arg | membership_collection | Search/List acquisitions_units membership | |||||||||||||||||||||
86 | GET | /acquisitions-units-storage/memberships/<id> | N/A | membership | Get acquisitions_unit membership by id | |||||||||||||||||||||
87 | PUT | /acquisitions-units-storage/memberships/<id> | membership | 204 | Update acquisitions_unit membership by id | |||||||||||||||||||||
88 | DELETE | /acquisitions-units-storage/memberships/<id> | N/A | 204 | Delete acquisitions_unit membership by id | |||||||||||||||||||||
89 | POST | /orders-storage/acquisitions-unit-assignments | assignment | assignment | Create acquisitions_unit assignment | https://issues.folio.org/browse/MODORDSTOR-92 | ||||||||||||||||||||
90 | GET | /orders-storage/acquisitions-unit-assignments | CQL query arg | assignment_collection | Search/List acquisitions_units assignment | |||||||||||||||||||||
91 | GET | /orders-storage/acquisitions-unit-assignments/<id> | N/A | assignment | Get acquisitions_unit assignment by id | |||||||||||||||||||||
92 | PUT | /orders-storage/acquisitions-unit-assignments/<id> | assignment | assignment | Update acquisitions_unit assignment by id | |||||||||||||||||||||
93 | DELETE | /orders-storage/acquisitions-unit-assignments/<id> | N/A | 204 | Delete acquisitions_unit assignment by id | |||||||||||||||||||||
94 | POST | /orders-storage/order-templates | order_template | order_template | Create order template | https://issues.folio.org/browse/MODORDSTOR-106 | ||||||||||||||||||||
95 | GET | /orders-storage/order-templates | CQL query arg | order_template_collection | Search/List order templates | |||||||||||||||||||||
96 | GET | /orders-storage/order-templates/<id> | N/A | order_template | Getorder template by id | |||||||||||||||||||||
97 | PUT | /orders-storage/order-templates/<id> | order_template | 204 | Update order template by id | |||||||||||||||||||||
98 | DELETE | /orders-storage/order-templates/<id> | N/A | 204 | Delete order template by id | |||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 | ||||||||||||||||||||||||||