Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

URL

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

Method

GET

Description

Receive a list of all available orders in the PTLControl.

Response

{
   «orderid»: [
      { "article": «article description», "location": «location», 
          "ordered": «amount ordered», "picked": «amount picked»
      },
      ...
   ],
   ...
}

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

Possible Error

HTTP404 with no body when no orders found.

Status

DESIGN

URL

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

Method

GET

Description

Receive the lines in order «orderid».

Response

[
  { "article": «article description», "location": «location», 
      "ordered": «amount ordered», "picked": «amount picked»
  },
  ...
]

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

Possible Error

HTTP404 with no body when the order was not found.

Status

DESIGN

URL

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

Method

DELETE

Description

Delete all orders

Response

HTTP204

Status

DESIGN

URL

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

Method

DELETE

Description

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

Response

HTTP204

Possble Error

HTTP404 with no body if order not found

Status

DESIGN

URL

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

Method

POST

Description

Create a new order. The Content-Type request header defines the data type that is being sent:

  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for Excel files

  • … ?

Response

HTTP201 without body if created or updated

Possible Error

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

Status

DESIGN

  • No labels