...
REQUEST |
POST API/ troubleTicket Content-type: application/json
{ "description": "Customer complaint over last invoice.", "severity": "Urgent", "type": "Bills, charges or payment" } |
| RESPONSE |
201 Content-Type: application/json { "id": "1", "correlationId": "TT53482", "description": "Customer complaint over last invoice.", "severity": "Urgent", "type": "Bills, charges or payment", "creationDate": "2013-07-23T08:16:39.0Z", "targetResolutionDate": "2013-07-30T10:20:01.0Z", "status": "Created", "subStatus": "", "statusChangeReason": "", "statusChangeDate": "2013-07-24T08:55:12.0Z", "resolutionDate": "", "relatedParty": [ ], "relatedObject": [ ], "note": [ ] |
| Anchor | ||||
|---|---|---|---|---|
|
...
| { "id": "42", "href": "http://serverlocation:port/orderManagement/productOrder/42", "externalId": "NiceNameForTheConsumer_42", "priority": "1", "description": "A wonderful 42 order for brand new products", "category": "residential", "state": "InProgress", "orderDate": "2013-04-12T16:42:23-04:00", "completionDate": "2013-04-19T16:42:23-04:00", "requestedStartDate": "2013-04-12T16:42:23-04:00", "requestedCompletionDate": "2013-04-19T16:42:23-04:00", "expectedCompletionDate": "2013-04-19T16:42:23-04:00", "notificationContact": "[email protected]", "note": [ { "text": "A free text detailing the note", "date": "2013-04-12T16:42:23-04:00", "author": "name" } ], "relatedParty": [ { "role": "customer", "id": "345221", "href": "http://serverlocation:port/partyManagement/customer/345221", "name": "John Doe" }, { "role": "partner", "id": "42", "href": "http://serverlocation:port/partyManagement/partner/42" }, { "role": "seller", "id": "4563", "href": "http://serverlocation:port/partnerManagement/partner/4563" } ], "orderItem": [ { "id": "1", "action": "add", "state": "Acknowledged", "billingAccount": [ { "id": "123456", "href": "http://serverlocation:port/billingManagement/billingAccount/123456" } ], "appointment": "http://www.doodle.com/1WCV5647438", "productOffering": { "id": "42", "href": "http: //serverlocation: port/catalogManagement/productOffering/42" }, "product": { "place": { "href": "http://map.google.com/.../1234112GDE", "role": "DeliveryPlace" }, "productCharacteristic": [ { "name": "Colour", "value": "White" }, { "name": "Memory", "value": "16" } ] } }, { "id": "2", "action": "modify", "state": "InProgress", "productOffering": { "id": "43", "href": "http: //serverlocation: port/catalogManagement/productOffering/43" }, "product": { "id": "456", "href": "http: //serverlocation: port/inventoryManagement/product/456", "productCharacteristic": [ { "name": "anotherCharacteristic", "value": "itsValue" } ], "relatedParty": [ { "role": "user", "id": "5667443", "href": "http://serverlocation:port/partyManagement/user/5667443", "name": "Jimmy Doe" } ] } }, { "id": "3", "action": "add", "state": "InProgress", "billingAccount": [ { "id": "123456", "href": "http://serverlocation:port/billingManagement/billingAccount/123456" } ], "productOffering": { "id": "51", "href": "http: //serverlocation: port/catalogManagement/productOffering/51" }, "product": { "id": "511", "href": "http: //serverlocation: port/inventoryManagement/product/456", "productCharacteristic": [ { "name": "anotherCharacteristic", "value": "itsValue" } ], "productRelationship": [ { "type": "reliesOn", "product": { "productCharacteristic": [ { "name": "MSISDN", "value": "003467488299002" } ] } } ] } }, { "id": "4", "action": "add", "state": "InProgress", "billingAccount": [ { "id": "1789", "href": "http://serverlocation:port/billingManagement/billingAccount/1789" } ], "productOffering": { "id": "44", "href": "http://serverlocation:port/catalogManagement/productOffering/Bundle44", "bundledProductOffering": [ { "id": " BundledPSTN444", "href": "http://serverlocation:port/catalogManagement/productOffering/BundledPSTN444" }, { "id": " Bundled Mobile443", "href": "http://serverlocation:port/catalogManagement/productOffering/BundledMobile443" } ] }, "product": { "productRelationship": [ { "type": "bundled", "product": { "productCharacteristic": [ { "name": "PSTNNumber", "value": "003427488299002" } ] } }, { "type": "bundled", "product": { "productCharacteristic": [ { "name": "MobileNumber", "value": "003464553000300" } ] } } ] } } ] } |
GET /orderManagement/productOrder/{ID}
Note that collections can be retrieved via GET /orderManagement/productOrder with no {ID}
...
Attribute selection may optionally be enabled on all attributes and inner classes.
Behavior :
· Return status codes
o 200 OK - the request was successful
o 404 Not found - the supplied ID does not match a known productOrder
Use case : Get a specific order based on its ID
REQUEST |
GET /orderManagement/productOrder/42 Accept: application/ |
json |
RESPONSE |
200 Content-Type: application/json |
{ "appointment":"http://www.doodle.com/1WCV5647438", |
}, { |
} |
POST
...
orderManagement/
...
productorder
Content-type: application/json
{
"description": "Customer complaint over last invoice.",
"severity": "Urgent",
...
Description:
This operation is used to create a new order.
The mandatory attributes for the creation are :
- relatedParties.role and reference to identify at least the customer
- at least one orderItem with :
- an action
- a productOffering
Behavior :
- Return status codes
- 201 Created - the request was successful
- 400 Bad Request – error
REQUEST |
POST /orderManagement/productOrder Content-type: application/json
{ "note":[ |
RESPONSE |
201 Content-Type: application/json
{ |