...
Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.
...
GET /orderManagement/productOrder/{ID}
Note that collections can be retrieved via GET /orderManagement/productOrder with no {ID}
Description :
This operation is used to retrieve order information using the ID
Attribute selection is enabled on all first level attributes but not on inner classes.
Attribute selection may optionally be enabled on all attributes and inner classes.
Behavior :
...
REQUEST |
GET /orderManagement/productOrder/42 |
RESPONSE |
200 Content-Type: application/json
{ "appointment":"http://www.doodle.com/1WCV5647438", { |
...
...
GET /orderManagement/productOrder/?{field selector}&{filtering expression}
Description :
This operation is used to retrieve order information using filter criteria.
Filtering selection is enabled on all first level attributes but not on inner classes with the exception of relatedParties.
Filtering may optionally be enabled on all attributes and inner classes.
Attribute selection is enabled on all first level attributes but not on inner classes.
Attribute selection may optionally be enabled on all attributes and inner classes.
Behavior :
...
REQUEST |
GET /orderManagement/productOrder?relatedParty.role=customer& relatedParty.id=345221&completionDate.lt=2013-09-10 T00:00:00 -04:00 |
RESPONSE |
200 Content-Type: application/json
[ "appointment":"http://www.doodle.com/1WCV5647438", { |
...
...
PATCH /orderManagement/productOrder/{ID}
Description :
This operation is used to modify orders and/or their items.
Behavior :
...
REQUEST |
PATCH orderManagement/productOrder/42 |
RESPONSE |
201 Content-Type: application/json
{ "appointment":"http://www.doodle.com/1WCV5647438", { |
...
...
POST orderManagement/productorder
Description:
This operation is used to create a new order.
The mandatory attributes for the creation are :
...
REQUEST |
POST /orderManagement/productOrder Content-type: application/json
{ "note":[ |
RESPONSE |
201 Content-Type: application/json
{ |
...
DELETE orderManagement/productorder/{ID}
This operation is used to delete a managed entity or a product order entirely.
Warning : it should only be used for administration matters
Description :
This operation is used to delete an order.
The only usable and also mandatory attributes for the deletion are id AND/OR href.
Behavior :
...