Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 2 Next »

Get Orders

Get a list of orders based on our access rights, if you are both sending and receiving orders with the same user this list will contain both. You can use the query parameter mode to filter this, if you are only either sending orders or receiving them you can ignore this parameter.

 

URLhttps://api.order.boknett.no/orders
MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
Request query parametersfromDateRequiredFrom date you you want to get the list of orders based on (based on creation date of the order)
modeOptionalSENT_TO_ME | SENT_BY_ME | ALL (default)
Response
body
Response HAL JSON document 
Response headersContent-typeapplication/hal+json
Returns200OK
40xOn error

Get Order

 Get single order based on Bokbasen's order-id. This view gives all available details on the order and order lines.

 

URLhttps://api.order.boknett.no/orders/{ID}
MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
Response
body
Response HAL JSON document 
Response headersContent-typeapplication/hal+json
Returns200OK
40xOn error

 

Get Order EDItX document

Get the EDItX XML representation of a given order based on Bokbasen's order-ID.

 

URLhttps://api.order.boknett.no/orders/{ID}/EDItX
MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
Response
body
EDItX XML document
Response headersContent-typetext/xml
Returns200OK
40xOn error
  • No labels