mod-orders

/orders-storage/order-template-categories

Collection of order-template-category items.

/orders-storage/order-template-categories post get

post

Create new order template

get

Get list of order template category

Create new order template

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Order Template Category",
  "type": "object",
  "javaName": "OrderTemplateCategory",
  "properties": {
    "id": {
      "description": "UUID of order template category",
      "$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}$"
    },
    "name": {
      "description": "The name of order template category",
      "type": "string"
    }
  },
  "additionalProperties": true,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "Sample Order Template Category"
}

HTTP status code 201

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

Headers

Location: required(string)
URI to the created order-template-category item

Body

Media type: application/json

Type: any

Example:

{
  "name": "Sample Order Template Category"
}

HTTP status code 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-category -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create order-template-categories -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Get list of order template category

Request
Response

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 name
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

["name", "Fiction", "="]
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
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
```

HTTP status code 200

Returns a list of order-template-category items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of order template categories",
  "type": "object",
  "javaName": "OrderTemplateCategoryCollection",
  "properties": {
    "orderTemplateCategories": {
      "description": "Collection of order template categories",
      "type": "array",
      "id": "orderTemplateCategories",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Order Template Category",
        "javaName": "OrderTemplateCategory",
        "properties": {
          "id": {
            "description": "UUID of order template category",
            "$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}$"
          },
          "name": {
            "description": "The name of order template category",
            "type": "string"
          }
        },
        "additionalProperties": true,
        "required": [
          "name"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects in DB in general for incoming search criteria.",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "orderTemplateCategories",
    "totalRecords"
  ]
}

Example:

{
  "orderTemplateCategories": [
    {
      "id": "3dee318b-f5b3-40dc-be93-cc89b8c45b6f",
      "name": "Sample Order Template Category"
    }
  ],
  "totalRecords": 1
}

HTTP status code 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-template-categories -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list order-template-categories -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

/orders-storage/order-template-categories/{id} put delete get

Entity representing a order-template-category

put

Update order template category

delete

Delete order template category

get

Retrieve order-template-category item with given {order-template-categoryId}

Update order template category

Request
Response

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 Category

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Order Template Category",
  "type": "object",
  "javaName": "OrderTemplateCategory",
  "properties": {
    "id": {
      "description": "UUID of order template category",
      "$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}$"
    },
    "name": {
      "description": "The name of order template category",
      "type": "string"
    }
  },
  "additionalProperties": true,
  "required": [
    "name"
  ]
}

Example:

{
  "id": "3dee318b-f5b3-40dc-be93-cc89b8c45b6f",
  "name": "Sample Order Template Category"
}

HTTP status code 204

Item successfully updated

HTTP status code 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-category -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template-category not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete order template category

Request
Response

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 Category

HTTP status code 204

Item deleted successfully

HTTP status code 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-category -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template-category not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Retrieve order-template-category item with given {order-template-categoryId}

Request
Response

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 Category

HTTP status code 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 Category",
  "type": "object",
  "javaName": "OrderTemplateCategory",
  "properties": {
    "id": {
      "description": "UUID of order template category",
      "$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}$"
    },
    "name": {
      "description": "The name of order template category",
      "type": "string"
    }
  },
  "additionalProperties": true,
  "required": [
    "name"
  ]
}

Example:

{
  "id": "3dee318b-f5b3-40dc-be93-cc89b8c45b6f",
  "name": "Sample Order Template Category"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"order-template-category not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

mod-orders version v1

Order Template Categories

/orders-storage/order-template-categories

mod-orders version v1

Order Template Categories

/orders-storage/order-template-categories

/orders-storage/order-template-categories post get

post /orders-storage/order-template-categories

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

get /orders-storage/order-template-categories

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

/orders-storage/order-template-categories/{id} put delete get

put /orders-storage/order-template-categories/{id}

URI Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 409

Body

HTTP status code 422

Body

HTTP status code 500

Body

delete /orders-storage/order-template-categories/{id}

URI Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 422

Body

HTTP status code 500

Body

get /orders-storage/order-template-categories/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body