Content Comparison

http://<<ip address>>/rest/order/

GET

Receive a list of all available orders in the PTLControl.

{
   «orderid»: {
      "orderlines": [
          { 
  "article          "articledescription": «article description», 
            "articlebarcode": «article barcode», 
            "location": «location», 
            "ordered": «amount ordered», 
            "picked": «amount picked»
          },
          ...
      ],
      "tote": «order tote»
  },
   ...
}

Note that «amount picked» can be null if the line has not been processed yet.

HTTP404 with no body when no orders found.

http://<<ip address>>/rest/order/«orderid»

GET

Receive the lines in order «orderid».

{
      "orderlines": [
          { 
            "articlearticledescription": «article description», 
            "articlebarcode": «article barcode», 
            "location": «location», 
            "ordered": «amount ordered»ordersed», 
            "picked": «amount picked»
          },
          ...
      ],              
      "tote": «order tote»
}

Note that «amount picked» can be null if the line has not been processed yet.

HTTP404 with no body when the order was not found.

http://<<ip address>>/rest/order/

DELETE

Delete all orders

HTTP204

http://<<ip address>>/rest/order/«orderid»

DELETE

Delete order with orderid «orderid» «oderid». There is no reason not to delete an order, i.e. there are no checks on status, progress, lines, etc.

HTTP204

HTTP404 with no body if order not found

Note, when the order did not exist, this call still returns a HTTP204.

HTTP204d

http://<<ip address>>/rest/order/

POST

HTTP201 without body if created or updated

HTTP400 if request was invalid (e.g. invalid JSON). A human readable error message can be found in the body.

HTTP503 if order exists, but has picked lines

http://<<ip address>>/rest/order/«orderid»

PUT

HTTP200 without body if updated

HTTP404 if order was not found.