http://github.com/folio-org/mod-orders-storage
This module implements the CRUD interface for Order Templates API. This API is intended for internal use only.
Collection of order-template items.
Create new order template
POST /orders-storage/order-templatesRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Order template",
"type": "object",
"properties": {
"id": {
"description": "UUID of order template",
"$ref": "../../common/schemas/uuid.json"
},
"templateName": {
"description": "The order template name",
"type": "string"
},
"templateCode": {
"description": "The order template code",
"type": "string"
},
"templateDescription": {
"description": "The order template description",
"type": "string"
}
},
"additionalProperties": true,
"required": [
"templateName"
]
}
Example:
{
"templateName": "Amazon book orders",
"templateCode": "Amazon-B",
"templateDescription": "Use to create orders in FOLIO after they are placed on Amazon"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created order-template item
Media type: application/json
Type: any
Example:
{
"templateName": "Amazon book orders",
"templateCode": "Amazon-B",
"templateDescription": "Use to create orders in FOLIO after they are placed on Amazon"
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to add order-template -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create order-templates -- unauthorizedValidation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorGet list of order templates
GET /orders-storage/order-templatesA query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example templateCode
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
["templateCode", "Amazon", "="]
Skip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response
Example:
10Requested language. Optional. [lang=en]
Returns a list of order-template items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of order templates",
"type": "object",
"properties": {
"orderTemplates": {
"description": "Collection of order templates",
"type": "array",
"id": "orderTemplates",
"items": {
"type": "object",
"$ref": "order_template.json"
}
},
"totalRecords": {
"description": "The number of objects contained in this collection",
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"orderTemplates",
"totalRecords"
]
}
Example:
{
"orderTemplates":[
{
"id": "4dee318b-f5b3-40dc-be93-cc89b8c45b6f",
"templateName": "Amazon book orders",
"templateCode": "Amazon-B",
"templateDescription": "Use to create orders in FOLIO after they are placed on Amazon"
}
],
"totalRecords":1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to list order-templates -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list order-templates -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorUpdate order template
PUT /orders-storage/order-templates/{id}The UUID of an Order Template
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Order template",
"type": "object",
"properties": {
"id": {
"description": "UUID of order template",
"$ref": "../../common/schemas/uuid.json"
},
"templateName": {
"description": "The order template name",
"type": "string"
},
"templateCode": {
"description": "The order template code",
"type": "string"
},
"templateDescription": {
"description": "The order template description",
"type": "string"
}
},
"additionalProperties": true,
"required": [
"templateName"
]
}
Example:
{
"id": "4dee318b-f5b3-40dc-be93-cc89b8c45b6f",
"templateName": "Amazon book orders",
"templateCode": "Amazon-B",
"templateDescription": "Use to create orders in FOLIO after they are placed on Amazon"
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update order-template -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"order-template not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorRetrieve order-template item with given {order-templateId}
GET /orders-storage/order-templates/{id}The UUID of an Order Template
Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Order template",
"type": "object",
"properties": {
"id": {
"description": "UUID of order template",
"$ref": "../../common/schemas/uuid.json"
},
"templateName": {
"description": "The order template name",
"type": "string"
},
"templateCode": {
"description": "The order template code",
"type": "string"
},
"templateDescription": {
"description": "The order template description",
"type": "string"
}
},
"additionalProperties": true,
"required": [
"templateName"
]
}
Example:
{
"id": "4dee318b-f5b3-40dc-be93-cc89b8c45b6f",
"templateName": "Amazon book orders",
"templateCode": "Amazon-B",
"templateDescription": "Use to create orders in FOLIO after they are placed on Amazon"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"order-template not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete order-template item with given {order-templateId}
DELETE /orders-storage/order-templates/{id}The UUID of an Order Template
Requested language. Optional. [lang=en]
Item deleted successfully
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to delete order-template -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"order-template not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator