Permalink
Cannot retrieve contributors at this time
#%RAML 1.0 | |
title: Edge API - Orders | |
baseUri: https://github.com/folio-org/edge-orders | |
version: v2 | |
traits: | |
errors: !include traits/errors.raml | |
documentation: | |
- title: Edge API - Orders | |
content: Edge API to interface with FOLIO for 3rd party purchasing systems for placing orders | |
/orders/validate: | |
displayName: Validate | |
get: | |
description: Validate that the API Key provided can be used to place an order. | |
responses: | |
200: | |
description: Success. The response body depends on the "type" query argument in the request (GOBI or other). | |
400: | |
description: Bad Request. | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
401: | |
description: Access Denied. | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
408: | |
description: Request Timeout. | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
500: | |
description: Internal Server Error. | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
example: "Internal server error" | |
queryParameters: | |
type: | |
description: purchasing system type | |
type: string | |
apikey: | |
description: API Key | |
type: string | |
post: | |
description: Validate that the API Key provided can be used to place an order. | |
responses: | |
200: | |
description: Success. The response body depends on the "type" query argument in the request (GOBI or other). | |
400: | |
description: Bad Request | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
401: | |
description: Access Denied | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
408: | |
description: Request Timeout | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
500: | |
description: Internal Server Error | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
example: "Internal server error" | |
queryParameters: | |
type: | |
description: purchasing system type | |
type: string | |
apikey: | |
description: API Key | |
type: string | |
/orders: | |
displayName: Place Order | |
post: | |
description: Place an order. | |
headers: | |
Accept: | |
displayName: Accept | |
description: Any valid accept header for third party Vendor | |
type: string | |
required: false | |
responses: | |
201: | |
description: Success. The response body depends on the "type" query argument in the request (GOBI or other). | |
400: | |
description: Bad Request | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
401: | |
description: Access Denied | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
408: | |
description: Request Timeout | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
500: | |
description: Internal Server Error | |
body: | |
application/xml: | |
example: !include examples/error.xml | |
application/json: | |
example: !include examples/error.json | |
text/plain: | |
example: "Internal server error" | |
queryParameters: | |
type: | |
description: purchasing system type | |
type: string | |
apikey: | |
description: API Key | |
type: string | |
/order-lines: | |
/{id}: | |
uriParameters: | |
id: | |
description: poLine number for orders | |
type: string | |
get: | |
description: Get order line by id | |
queryParameters: | |
type: | |
description: purchasing system type | |
type: string | |
apikey: | |
description: API Key | |
type: string | |
is: [errors] | |
responses: | |
200: | |
description: Success. The response body depends on the "type" query argument in the request | |
put: | |
description: Update order line | |
queryParameters: | |
type: | |
description: purchasing system type | |
type: string | |
apikey: | |
description: API Key | |
type: string | |
is: [errors] | |
responses: | |
204: | |
description: Success update | |
/admin/health: | |
displayName: Health Check | |
get: | |
description: Health Check | |
responses: | |
200: | |
description: Success | |
body: | |
text/plain: null |