Path: / rest / orders

List of all orders


Method Summary
ResourceDescription
GET /rest/orders?filter=…&creator=…List of all orders
POST /rest/ordersAdds a new order
PUT /rest/orders 
HEAD /rest/orders 
DELETE /rest/orders 

Method Detail
HTTP Example:
GET /rest/orders?filter=…&creator=…

API Example:

RESTOrders.getOrders({'filter': /* filter name of a filter to apply */,
  'creator': /* creatorKey filter results so that their creators must match this key */});

List of all orders

Output:
javax.ws.rs.core.Response - a list of orders
Query parameters:
filter - name of a filter to apply
creator - filter results so that their creators must match this key
Produces:
application/xml
text/plain
HTTP Example:
POST /rest/orders

API Example:

RESTOrders.postOrders({'$entity': /* newOrder the new order to add */});

Adds a new order

Input:
RESTOrdersBean.Order - the new order to add
Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP return codes:
201 - When created
401 - If authentication failed
HTTP Example:
PUT /rest/orders

API Example:

RESTOrders.putOrders({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP Example:
HEAD /rest/orders

API Example:

RESTOrders.headOrders({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP Example:
DELETE /rest/orders

API Example:

RESTOrders.deleteOrders({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain