ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
mod-orders
2
MethodPathRequestResponseDescriptionUsage
3
POST/orders/composite-orderscomposite_purchase_ordercomposite_purchase_orderCreate a new order w/ or w/o po_linesui-orders: new purchase_order, mod-gobi: order placement
4
GET/orders/composite-ordersCQL query argpurchase_order_collectionSearch/List purchase_ordersui-orders: main listing of orders w/ search and filteringNOTE: renamed schema for consistency
5
GET/orders/composite-orders/<id>N/Acomposite_purchase_orderGet all information about this orderui-orders: when row is selected from main listing
6
PUT/orders/composite-orders/<id>composite_purchase_order204Edit this order w/ or w/o po_linesui-orders: edit purchase_order
7
DELETE/orders/composite-orders/<id>N/A204Delete this order and all related dataui-orders: remove purchase_order
8
POST/orders/order-linescomposite_po_linecomposite_po_lineAdd a po_line to this orderui-orders: new po_line
9
GET/orders/order-linesCQL query argpo_line_collectionSearch/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/Acomposite_po_lineGet this po_line and related sub-objectsui-orders: display po_line details, ui-inventory: get orders data related to an item/holding/instanceNOTE: this functionality is needed to integrate w/ inventory
11
PUT/orders/order-lines/<id>composite_po_line204Edit this po_line or related sub-objectsui-orders: edit a po_line
12
DELETE/orders/order-lines/<id>N/A204Delete this po_line and all related dataui-orders: delete a po_line
13
POST/orders/receivereceiving_collectionreceiving_collectionReceive items spanning one or more po_lines in this orderui-orders: receiving modal
14
POST/orders/check-incheckin_collectioncheckin_collectionCheck-in items spanning one or more po_lines in this orderui-orders: check-in modal
15
GET/orders/receiving-historyCQL query argreceiving_history_collectionGet receiveing history matching the provided criteriaui-receiving: main listing of receiving history w/ search and filtering
16
GET/orders/po-numberN/Apo_numberGet an auto-generated po_number (with optional prefix?)ui-orders: new purchase_order
17
POST/orders/po-number/validatepo_number204/400Check if the provided po_number is valid and uniqueui-orders: new purchase_order
18
POST/orders/piecespiecepieceAdd a piece to a check-in orderui-orders: check-in modal (add piece)
19
PUT/orders/peices/<id>piece204Update piece by idui-orders: check-in modal (edit piece)
20
DELETE/orders/peices/<id>N/A204Delete piece by idui-orders: check-in modal (remove piece)
21
POST/acquisitions-units/unitsacquisitions_unitacquisitions_unitCreate acquisitions_unithttps://issues.folio.org/browse/MODORDERS-249
22
GET/acquisitions-units/unitsCQL query argacquisitions_unit_collectionSearch/List acquisitions_units
23
GET/acquisitions-units/units/<id>N/Aacquisitions_unitGet acquisitions_unit by id
24
PUT/acquisitions-units/units/<id>acquisitions_unit204Update acquisitions_unit by id
25
DELETE/acquisitions-units/units/<id>N/A204
Update acquisitions unit by id setting the "isDeleted" field to true
26
POST/acquisitions-units/membershipsmembershipmembershipCreate acquisitions_unit membershiphttps://issues.folio.org/browse/MODORDERS-250
27
GET/acquisitions-units/membershipsCQL query argmembership_collectionSearch/List acquisitions_units membership
28
GET/acquisitions-units/memberships/<id>N/AmembershipGet acquisitions_unit membership by id
29
PUT/acquisitions-units/memberships/<id>membership204Update acquisitions_unit membership by id
30
DELETE/acquisitions-units/memberships/<id>N/A204Delete acquisitions_unit membership by id
31
POST/orders/acquisitions-unit-assignmentsassignmentassignmentCreate acquisitions_unit assignmenthttps://issues.folio.org/browse/MODORDERS-266
32
GET/orders/acquisitions-unit-assignmentsCQL query argassignment_collectionSearch/List acquisitions_units assignment
33
GET/orders/acquisitions-unit-assignments/<id>N/AassignmentGet acquisitions_unit assignment by id
34
PUT/orders/acquisitions-unit-assignments/<id>assignmentassignmentUpdate acquisitions_unit assignment by id
35
DELETE/orders/acquisitions-unit-assignments/<id>N/A204Delete acquisitions_unit assignment by id
36
POST/orders/order-templatesorder_templateorder_templateCreate order templatehttps://issues.folio.org/browse/MODORDSTOR-107
37
GET/orders/order-templatesCQL query argorder_template_collectionSearch/List order templates
38
GET/orders/order-templates/<id>N/Aorder_templateGetorder template by id
39
PUT/orders/order-templates/<id>order_template204Update order template by id
40
DELETE/orders/order-templates/<id>N/A204Delete order template by id
41
42
mod-orders-storage
43
MethodPathRequestResponseDescriptionUsage
44
POST/orders-storage/purchase-orderspurchase_orderpurchase_orderCreate purchase_ordermod-orders: POST/orders/composite-orders
45
GET/orders-storage/purchase-ordersCQL query argpurchase_order_collectionSearch/List purchase_ordersmod-orders: POST /po-number/validate
46
GET/orders-storage/purchase-orders/<id>N/Apurchase_orderGet purchase_order by idmod-orders: GET /orders/composite-orders/<id>
47
PUT/orders-storage/purchase-orders/<id>purchase_order204Update purchase_order by idmod-orders: PUT /orders/composite-orders/<id>
48
DELETE/orders-storage/purchase-orders/<id>N/A204Delete purchase order by idmod-orders: DELETE /orders/composite-orders/<id>
49
POST/orders-storage/po-linespo_linepo_lineCreate po_linemod-orders: POST /orders, mod-orders: POST /orders/order-linesNOTE: po_line now includes: adjustments, claims, cost, detail, eresource, fund_distribution, license, location, physical, source, vendor_detail
50
GET/orders-storage/po-linesCQL query argpo_line_collectionSearch/List po_linesmod-orders: GET /orders/composite-orders/<id>/order-lines
51
GET/orders-storage/po-lines/<id>N/Apo_lineGet po_line by idmod-orders: GET /orders/order-lines/<id>
52
PUT/orders-storage/po-lines/<id>po_line204Update po_line by idmod-orders: PUT /orders/order-lines/<id>, mod-orders: PUT /orders/id
53
DELETE/orders-storage/po-lines/<id>N/A204Delete po_line by idmod-orders: DELETE /orders/order-lines/<id>
54
POST/orders-storage/peicespiecepieceCreate piecemod-orders: POST /orders/receive, mod-orders: POST /orders/check-in
55
GET/orders-storage/peicesCQL query argpiece_collectionSearch/List piecesmod-orders: POST /orders/receive, mod-orders: POST /orders/check-in
56
GET/orders-storage/peices/<id>N/ApieceGet piece by idmod-orders: POST /orders/receive, mod-orders: POST /orders/check-in
57
PUT/orders-storage/peices/<id>piece204Update piece by idmod-orders: POST /orders/receive, mod-orders: POST /orders/check-in
58
DELETE/orders-storage/peices/<id>N/A204Delete piece by idmod-orders: ???
Would we remove piece records if order or line are removed?
59
POST/orders-storage/alertsalertalertCreate alertmod-orders: ???Are reporting_codes something we can store in mod-configuration?
60
GET/orders-storage/alertsCQL query argalert_collectionSearch/List alertsmod-orders: ???
61
GET/orders-storage/alerts/<id>N/AalertGet alert by idmod-orders: ???
62
PUT/orders-storage/alerts/<id>alert204Update alert by idmod-orders: ???
63
DELETE/orders-storage/alerts/<id>N/A204Delete alert by idmod-orders: ???
64
POST/orders-storage/reporting-codesreporting_codereporting_codeCreate reporting_codesmod-orders: ???
65
GET/orders-storage/reporting-codesCQL query argreporting_code_collectionSearch/List reporting_codesmod-orders: ???
66
GET/orders-storage/reporting-codes/<id>N/Areporting_codeGet reporting_code by idmod-orders: ???
67
PUT/orders-storage/reporting-codes/<id>reporting_code204Update reporting_code by idmod-orders: ???
68
DELETE/orders-storage/reporting-codes/<id>N/A204Delete reporting_code by idmod-orders: ???
69
GET/orders-storage/ordersCQL query argpurchase_order_collection
For querying a view combining purchase_orders, po_lines, etc.
mod-orders: GET /orders/composite-orders
70
GET/orders-storage/order-linesCQL query argpo_line_collection
For querying a view combining purchase_orders, po_lines, etc.
mod-orders: GET /orders/order-lines
71
GET/orders-storage/receiving-historyCQL query argreceiving_history_collectionFor querying a view combining po_lines, pieces, etc.mod-orders: GET /orders/receiving-history
72
GET/orders-storage/po-numberN/Asequence_numberGet the next value in the po_number sequencemod-orders: GET /orders/po-number
73
GET/orders-storage/po-line-numberpurchaseOrderId query argsequence_numberGet the next value in the PO's po_line_number sequencemod-orders: POST /orders, mod-orders: PUT /orders, mod-orders: POST /orders/lines, mod-orders: PUT /orders/lines/<id>
74
POST/order-storage/order-invoice-relnsorder_invoice_relationshiporder_invoice_relationshipCreate an order_invoice_relationshiphttps://issues.folio.org/browse/MODORDSTOR-80
75
GET/order-storage/order-invoice-relnsCQL query argorder_invoice_relationship_collectionSearch/List order_invoice_relationship
76
GET/order-storage/order-invoice-relns/<id>NAorder_invoice_relationshipGet an order_invoice_relationship by ID
77
PUT/order-storage/order-invoice-relns/<id>order_invoice_relationship204Edit an order_invoice_relationship
78
DELETE/order-storage/order-invoice-relns/<id>NA204Delete an order_invoice_relationship
79
POST/acquisitions-units-storage/unitsacquisitions_unitacquisitions_unitCreate acquisitions_unithttps://issues.folio.org/browse/MODORDSTOR-82
80
GET/acquisitions-units-storage/unitsCQL query argacquisitions_unit_collectionSearch/List acquisitions_units
81
GET/acquisitions-units-storage/units/<id>N/Aacquisitions_unitGet acquisitions_unit by id
82
PUT/acquisitions-units-storage/units/<id>acquisitions_unit204Update acquisitions_unit by id
83
DELETE/acquisitions-units-storage/units/<id>N/A204Delete acquisitions_unit by id
84
POST/acquisitions-units-storage/membershipsmembershipmembershipCreate acquisitions_unit membershiphttps://issues.folio.org/browse/MODORDSTOR-83
85
GET/acquisitions-units-storage/membershipsCQL query argmembership_collectionSearch/List acquisitions_units membership
86
GET/acquisitions-units-storage/memberships/<id>N/AmembershipGet acquisitions_unit membership by id
87
PUT/acquisitions-units-storage/memberships/<id>membership204Update acquisitions_unit membership by id
88
DELETE/acquisitions-units-storage/memberships/<id>N/A204Delete acquisitions_unit membership by id
89
POST/orders-storage/acquisitions-unit-assignmentsassignmentassignmentCreate acquisitions_unit assignmenthttps://issues.folio.org/browse/MODORDSTOR-92
90
GET/orders-storage/acquisitions-unit-assignmentsCQL query argassignment_collectionSearch/List acquisitions_units assignment
91
GET/orders-storage/acquisitions-unit-assignments/<id>N/AassignmentGet acquisitions_unit assignment by id
92
PUT/orders-storage/acquisitions-unit-assignments/<id>assignmentassignmentUpdate acquisitions_unit assignment by id
93
DELETE/orders-storage/acquisitions-unit-assignments/<id>N/A204Delete acquisitions_unit assignment by id
94
POST/orders-storage/order-templatesorder_templateorder_templateCreate order templatehttps://issues.folio.org/browse/MODORDSTOR-106
95
GET/orders-storage/order-templatesCQL query argorder_template_collectionSearch/List order templates
96
GET/orders-storage/order-templates/<id>N/Aorder_templateGetorder template by id
97
PUT/orders-storage/order-templates/<id>order_template204Update order template by id
98
DELETE/orders-storage/order-templates/<id>N/A204Delete order template by id
99
100