mod-orders (v1)

http://github.com/folio-org/mod-orders-storage

Table of contents

Order Templates

This module implements the CRUD interface for Order Templates API. This API is intended for internal use only.

/orders-storage/order-templates

Collection of order-template items.

POST /orders-storage/order-templates

Create new order template

POST /orders-storage/order-templates
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

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",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "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"
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created order-template item

Body

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"
}

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to add order-template -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create order-templates -- unauthorized

Response 422

Validation errors

Body

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",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "parameters": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "List of key/value parameters of an error",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /orders-storage/order-templates

Get list of order templates

GET /orders-storage/order-templates
Query Parameters
  • query: (string)

    A 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", "="]
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of order-template items

Body

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",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Order template",
        "properties": {
          "id": {
            "description": "UUID of order template",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "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"
        ]
      }
    },
    "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
}

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

unable to list order-templates -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list order-templates -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

PUT /orders-storage/order-templates/{id}

Update order template

PUT /orders-storage/order-templates/{id}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an Order Template

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

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",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "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"
}

Response 204

Item successfully updated

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to update order-template -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template not found"

Response 422

Validation errors

Body

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",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "parameters": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "description": "List of key/value parameters of an error",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

GET /orders-storage/order-templates/{id}

Retrieve order-template item with given {order-templateId}

GET /orders-storage/order-templates/{id}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an Order Template

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

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",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "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"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /orders-storage/order-templates/{id}

Delete order-template item with given {order-templateId}

DELETE /orders-storage/order-templates/{id}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an Order Template

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to delete order-template -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator