...

• Return status codes
  • 200 OK - the request was successful
  • 400 Bad Request - error

Further document any rules that must be implemented when patching attributes.

...

ID Management :
POST should be used without specifying the id and the href, the OM system is in charge of generating the id + href for the ProductOrder.
When performing a POST, these are the allowed attributes (all Product Order attributes that are not in that list MUST NOT be used during POST, they are calculated/defined by the OM system) :

...

• 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

• 403 if the operation is forbidden

  REQUEST

  DELETE /orderManagement/productOrder/5868839

  RESPONSE

  200

   

  © TM Forum 2015. All Rights Reserved.