mod-orders

/orders/acquisition-methods

Collection of acquisition-method items.

/orders/acquisition-methods get post

get

Get list of acquisition methods

post

Create a new acquisition-method item.

Get list of acquisition methods

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

["value", "Purchase At Vendor System", "="]
```
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 acquisition-method items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of acquisition method line records",
  "type": "object",
  "properties": {
    "acquisitionMethods": {
      "description": "collection of acquisition method line records",
      "type": "array",
      "id": "acquisitionMethods",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An acquisition method",
        "properties": {
          "id": {
            "description": "The unique id of this acquisition method",
            "$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}$"
          },
          "value": {
            "description": "The value of this acquisition method",
            "type": "string"
          },
          "source": {
            "description": "Source of acquisition method",
            "type": "string",
            "enum": [
              "User",
              "System"
            ],
            "default": "User"
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "value",
          "source"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionMethods",
    "totalRecords"
  ]
}

Example:

{
    "acquisitionMethods":
        [
          {
            "id": "73d14bc5-d131-48c6-b380-f8e62f63c8f3",
            "value": "Purchase At Vendor System",
            "source": "System",
            "metadata": {
              "createdDate": "2018-07-19T00:00:00.000+0000",
              "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
            }
          }
        ],
    "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 acquisition-methods -- 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 acquisition-methods -- 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

Create a new acquisition-method item.

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An acquisition method",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this acquisition method",
      "$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}$"
    },
    "value": {
      "description": "The value of this acquisition method",
      "type": "string"
    },
    "source": {
      "description": "Source of acquisition method",
      "type": "string",
      "enum": [
        "User",
        "System"
      ],
      "default": "User"
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "source"
  ]
}

Example:

{
  "id": "73d14bc5-d131-48c6-b380-f8e62f63c8f3",
  "value": "Purchase At Vendor System",
  "source": "System",
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 201

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

Headers

Location: required(string)
URI to the created acquisition-method item

Body

Media type: application/json

Type: any

Example:

{
  "id": "73d14bc5-d131-48c6-b380-f8e62f63c8f3",
  "value": "Purchase At Vendor System",
  "source": "System",
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

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 acquisition-method -- 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 acquisition-methods -- 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/acquisition-methods/{id} get delete put

Entity representing a acquisition-method

get

Retrieve acquisition-method item with given {acquisition-methodId}

delete

Delete acquisition-method item with given {acquisition-methodId}

put

Update acquisition-method item with given {acquisition-methodId}

Retrieve acquisition-method item with given {acquisition-methodId}

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 a Acquisition method

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": "An acquisition method",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this acquisition method",
      "$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}$"
    },
    "value": {
      "description": "The value of this acquisition method",
      "type": "string"
    },
    "source": {
      "description": "Source of acquisition method",
      "type": "string",
      "enum": [
        "User",
        "System"
      ],
      "default": "User"
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "source"
  ]
}

Example:

{
  "id": "73d14bc5-d131-48c6-b380-f8e62f63c8f3",
  "value": "Purchase At Vendor System",
  "source": "System",
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"acquisition-method 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

Delete acquisition-method item with given {acquisition-methodId}

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 a Acquisition method

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 acquisition-method -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"acquisition-method 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

Update acquisition-method item with given {acquisition-methodId}

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 a Acquisition method

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An acquisition method",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this acquisition method",
      "$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}$"
    },
    "value": {
      "description": "The value of this acquisition method",
      "type": "string"
    },
    "source": {
      "description": "Source of acquisition method",
      "type": "string",
      "enum": [
        "User",
        "System"
      ],
      "default": "User"
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "source"
  ]
}

Example:

{
  "id": "73d14bc5-d131-48c6-b380-f8e62f63c8f3",
  "value": "Purchase At Vendor System",
  "source": "System",
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

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 acquisition-method -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"acquisition-method not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

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

Acquisition method

/orders/acquisition-methods

/orders/acquisition-methods get post

get /orders/acquisition-methods

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

post /orders/acquisition-methods

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

/orders/acquisition-methods/{id} get delete put

get /orders/acquisition-methods/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body

delete /orders/acquisition-methods/{id}

URI Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body

put /orders/acquisition-methods/{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 500

Body