http://github.com/org/folio/mod-orders-storage
CRUD API to manage Titles. This API is intended for internal use only. Please use the /orders/titles, /orders/receiving, /orders/check-in, and /orders/receiving-history APIs provided by mod-orders instead.
Collection of title items.
Get list of titles
GET /orders-storage/titles
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 title
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
["title", "TITLE", "="]
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
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Returns a list of title items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of titles",
"type": "object",
"properties": {
"titles": {
"description": "Collection of titles",
"type": "array",
"id": "titles",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Title",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$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}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$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}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$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}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$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}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"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": [
"title",
"poLineId"
]
}
},
"totalRecords": {
"description": "The number of objects contained in this collection",
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"titles",
"totalRecords"
]
}
Example:
{
"titles": [
{
"id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d",
"expectedReceiptDate": "2018-10-05T00:00:00.000Z",
"title": "Sample Title",
"poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
"instanceId": "f1b57aeb-23c9-4386-bcb8-efda56878267",
"contributors": [
{
"contributor": "Ed Mashburn",
"contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
}
],
"packageName": "Package sample",
"poLineNumber": "268758-03",
"publisher": "Schiffer Publishing",
"publishedDate": "1972",
"receivingNote": "ABCDEFGHIJKL",
"edition": "Third Edt.",
"subscriptionFrom": "2018-10-09T00:00:00.000Z",
"subscriptionInterval": 824,
"subscriptionTo": "2020-10-09T00:00:00.000Z",
"claimingActive": false,
"claimingInterval": 0,
"isAcknowledged": true,
"productIds": [
{
"productId": "9780764354113",
"productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
"qualifier": "(paperback)"
}
],
"bindItemIds": [
"12975eb3-a6e4-486a-b773-0c79ec611a32",
"f02e8503-a5e2-4cc4-8f6b-034a1140de67"
],
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
],
"metadata": {
"createdDate": "2018-07-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
],
"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 titles -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list titles -- unauthorized
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a new title item.
POST /orders-storage/titles
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Title",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$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}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$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}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$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}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$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}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"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": [
"title",
"poLineId"
]
}
Example:
{
"title": "Sample Title",
"poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
"instanceId": "f1b57aeb-23c9-4386-bcb8-efda56878267",
"contributors": [
{
"contributor": "Ed Mashburn",
"contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
}
],
"publisher": "Schiffer Publishing",
"publishedDate": "1972",
"edition": "Third Edt.",
"subscriptionFrom": "2018-10-09T00:00:00.000Z",
"subscriptionInterval": 824,
"subscriptionTo": "2020-10-09T00:00:00.000Z",
"claimingActive": false,
"claimingInterval": 0,
"isAcknowledged": true,
"productIds": [
{
"productId": "9780764354113",
"productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
"qualifier": "(paperback)"
}
],
"bindItemIds": [
"12975eb3-a6e4-486a-b773-0c79ec611a32",
"f02e8503-a5e2-4cc4-8f6b-034a1140de67"
],
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
]
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created title item
Media type: application/json
Type: any
Example:
{
"title": "Sample Title",
"poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
"instanceId": "f1b57aeb-23c9-4386-bcb8-efda56878267",
"contributors": [
{
"contributor": "Ed Mashburn",
"contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
}
],
"publisher": "Schiffer Publishing",
"publishedDate": "1972",
"edition": "Third Edt.",
"subscriptionFrom": "2018-10-09T00:00:00.000Z",
"subscriptionInterval": 824,
"subscriptionTo": "2020-10-09T00:00:00.000Z",
"claimingActive": false,
"claimingInterval": 0,
"isAcknowledged": true,
"productIds": [
{
"productId": "9780764354113",
"productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
"qualifier": "(paperback)"
}
],
"bindItemIds": [
"12975eb3-a6e4-486a-b773-0c79ec611a32",
"f02e8503-a5e2-4cc4-8f6b-034a1140de67"
],
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
]
}
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 title -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create titles -- unauthorized
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve title item with given {titleId}
GET /orders-storage/titles/{id}
The UUID of a Title
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Title",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$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}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$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}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$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}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$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}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"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": [
"title",
"poLineId"
]
}
Example:
{
"id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d",
"expectedReceiptDate": "2018-10-05T00:00:00.000Z",
"title": "Sample Title",
"poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
"instanceId": "f1b57aeb-23c9-4386-bcb8-efda56878267",
"contributors": [
{
"contributor": "Ed Mashburn",
"contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
}
],
"packageName": "Package sample",
"poLineNumber": "268758-03",
"publisher": "Schiffer Publishing",
"publishedDate": "1972",
"receivingNote": "ABCDEFGHIJKL",
"edition": "Third Edt.",
"subscriptionFrom": "2018-10-09T00:00:00.000Z",
"subscriptionInterval": 824,
"subscriptionTo": "2020-10-09T00:00:00.000Z",
"claimingActive": false,
"claimingInterval": 0,
"isAcknowledged": true,
"productIds": [
{
"productId": "9780764354113",
"productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
"qualifier": "(paperback)"
}
],
"bindItemIds": [
"12975eb3-a6e4-486a-b773-0c79ec611a32",
"f02e8503-a5e2-4cc4-8f6b-034a1140de67"
],
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
],
"metadata": {
"createdDate": "2018-07-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"title not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete title item with given {titleId}
DELETE /orders-storage/titles/{id}
The UUID of a Title
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 title -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"title not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Update title item with given {titleId}
PUT /orders-storage/titles/{id}
The UUID of a Title
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Title",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$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}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$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}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$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}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$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}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"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}$"
}
},
"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": [
"title",
"poLineId"
]
}
Example:
{
"id": "9a665b22-9fe5-4c95-b4ee-837a5433c95d",
"expectedReceiptDate": "2018-10-05T00:00:00.000Z",
"title": "Sample Title",
"poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
"instanceId": "f1b57aeb-23c9-4386-bcb8-efda56878267",
"contributors": [
{
"contributor": "Ed Mashburn",
"contributorNameTypeId": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
}
],
"packageName": "Package sample",
"poLineNumber": "268758-03",
"publisher": "Schiffer Publishing",
"publishedDate": "1972",
"receivingNote": "ABCDEFGHIJKL",
"edition": "Third Edt.",
"subscriptionFrom": "2018-10-09T00:00:00.000Z",
"subscriptionInterval": 824,
"subscriptionTo": "2020-10-09T00:00:00.000Z",
"claimingActive": false,
"claimingInterval": 0,
"isAcknowledged": true,
"productIds": [
{
"productId": "9780764354113",
"productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
"qualifier": "(paperback)"
}
],
"bindItemIds": [
"12975eb3-a6e4-486a-b773-0c79ec611a32",
"f02e8503-a5e2-4cc4-8f6b-034a1140de67"
],
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
],
"metadata": {
"createdDate": "2018-07-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
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 title -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"title not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflict
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator