emailAddr

REQUEST
GET /orderManagement/productOrder/42 Accept: application/json
RESPONSE
200 Content-Type: application/json { "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":"	emailAddr[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" } ] } } ] } } ] }

Anchor
_Toc369265811
_Toc369265811
Anchor
_Toc405202667
_Toc405202667
GET /orderManagement/productOrder/?{field selector}&{filtering expression}

...

emailAddr

REQUEST
GET /orderManagement/productOrder?relatedParty.role=customer& relatedParty.id=345221&completionDate.lt=2013-09-10 T00:00:00 -04:00 Accept: application/json
RESPONSE
200 Content-Type: application/json [ { "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":"Completed", "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":"	emailAddr[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":"Completed", "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":"Completed", "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":"Completed", "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":"Completed", "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" } ] } } ] } } ] }]

Anchor
_Toc405202668
_Toc405202668
Anchor
_Ref234978967
_Ref234978967
Anchor
_Toc235288517
_Toc235288517
Anchor
_Toc236554611
_Toc236554611
Anchor
_Toc236554912
_Toc236554912
Anchor
_Toc236555375
_Toc236555375
Anchor
_Toc225613455
_Toc225613455
Anchor
_Toc225603244
_Toc225603244
Anchor
_Ref226733430
_Ref226733430
Anchor
_Ref230885009
_Ref230885009
Anchor
_Ref231980155
_Ref231980155
Anchor
_Ref232940733
_Ref232940733
Anchor
_Ref232940829
_Ref232940829
PATCH /orderManagement/productOrder/{ID}

...

emailAddr

REQUEST
PATCH orderManagement/productOrder/42 Content-type: application/json { "state":"InProgress"}
RESPONSE
201 Content-Type: application/json { "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":"	emailAddr[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":"InProgress", "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" } ] } } ] } } ] }

Anchor
_Toc369265814
_Toc369265814
Anchor
_Toc405202669
_Toc405202669
POST orderManagement/productorder

...

Further specify any rules on the creation of the entity

Rule name	Rule
POST Mandatory attributes within product Order	Within "billingAccount"

- id AND/OR href
Within "note"
- text
Within "relatedParty"
- id AND/OR href AND/OR name
- role|
  POST Mandatory attributes within product Order item
  Within "place"
- Role
- id AND/OR href
Within "productOffering"
- id AND/OR href
Within "product"
- Depends on the order item "action", cf. rule below|
  POST Mandatory attributes within product (in each order item)
  If orderItem.action = "add" :
- productCharacteristics
If orderItem.action = "modify"
- id AND/OR href

If orderItem.action = "delete"

id AND/OR href|

REQUEST

POST /orderManagement/productOrder

Content-type: application/json

{   "note":[
      {
         "text":"A free text detailing the note"
      }
   ],
   "relatedParty":[
      {
         "role":"customer",
         "id":"345221",
         "href":"http://serverlocation:port/partyManagement/customer/345221",
         "name":"John Doe"
      },
      {
         "role":"seller",
         "id":"4563",
         "href":"http://serverlocation:port/partnerManagement/partner/4563"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"add",
         "billingAccount":[{
               "id":"1789",
               "href":"http://serverlocation:port/billingManagement/billingAccount/1789"
         }],
         "productOffering":{
            "id":"42",
            "href":"http: //serverlocation: port/catalogManagement/productOffering/42"
         },
         "product":{
            "productCharacteristic":[
               {
                  "name":"Colour",
                  "value":"White"
               },
               {
                  "name":"Memory",
                  "value":"16"
               }
            ]
         }
      },
      {
         "id":"2",
         "action":"modify",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456",
            "relatedParty":[
               {
                  "role":"user",
                  "id":"5667443",
                  "href":"http://serverlocation:port/partyManagement/user/5667443",
                  "name":"Jimmy Doe"
               }
            ]
         }
      },
      {
         "id":"3",
         "action":"delete",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456"
         }
      }
   ]
}

RESPONSE

201

Content-Type: application/json

{
   "id":"42",
   "href":"http://serverlocation:port/orderManagement/productOrder/42",
   "priority":"4",
   "category":"uncategorized",
   "state":"Acknowledged",
   "orderDate":"2013-04-12T16:42:23-04:00",
   "expectedCompletionDate":"2013-04-19T16:42:23-04:00",   "note":[
      {
         "text":"A free text detailing the note"
      }
   ],
   "relatedParty":[
      {
         "role":"customer",
         "id":"345221",
         "href":"http://serverlocation:port/partyManagement/customer/345221"
         "name":"John Doe"
      },
      {
         "role":"seller",
         "id":"4563",
         "href":"http://serverlocation:port/partnerManagement/partner/4563"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"add",
         "state":"Acknowledged",
         "billingAccount":[{
               "id":"1789",
               "href":"http://serverlocation:port/billingManagement/billingAccount/1789"
         }],
         "productOffering":{
            "id":"42",
            "href":"http: //serverlocation: port/catalogManagement/productOffering/42"
         },
         "product":{
            "productCharacteristic":[
               {
                  "name":"Colour",
                  "value":"White"
               },
               {
                  "name":"Memory",
                  "value":"16"
               }
            ]
         }
      },
      {
         "id":"2",
         "action":"modify",
         "state":"Acknowledged",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456",
            "relatedParty":[
               {
                  "role":"user",
                  "id":"5667443",
                  "href":"http://serverlocation:port/partyManagement/user/5667443",
                  "name":"Jimmy Doe"
               }
            ]
         }
      },
      {
         "id":"3",
         "action":"delete",
         "state":"Acknowledged",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456"
         }
      }
   ]
}

Anchor
_Toc405202670
_Toc405202670
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 :

Returns HTTP/1.1 status code 200 if the request was successful.
404 if the product order does not exist

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Anchor
_Toc369265811
_Toc369265811
Anchor
_Toc405202667
_Toc405202667
GET /orderManagement/productOrder/?{field selector}&{filtering expression}

Anchor
_Toc369265814
_Toc369265814
Anchor
_Toc405202669
_Toc405202669
POST orderManagement/productorder

Anchor
_Toc405202670
_Toc405202670
DELETE orderManagement/productorder/{ID}

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 3

New Version 4

Key

Anchor_Toc369265811_Toc369265811 Anchor_Toc405202667_Toc405202667GET /orderManagement/productOrder/?{field selector}&{filtering expression}

Anchor_Toc369265814_Toc369265814 Anchor_Toc405202669_Toc405202669POST orderManagement/productorder

Anchor_Toc405202670_Toc405202670DELETE orderManagement/productorder/{ID}

Anchor
_Toc369265811
_Toc369265811
Anchor
_Toc405202667
_Toc405202667
GET /orderManagement/productOrder/?{field selector}&{filtering expression}

Anchor
_Toc369265814
_Toc369265814
Anchor
_Toc405202669
_Toc405202669
POST orderManagement/productorder

Anchor
_Toc405202670
_Toc405202670
DELETE orderManagement/productorder/{ID}