http://localhost:9130
Storage for fixed due date schedules
Retrieve a list of fixed-due-date-schedule items.
GET /fixed-due-date-schedule-storage/fixed-due-date-schedules
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. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10
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
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
name=semester
Returns a list of fixed-due-date-schedule items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of fixedDueDateSchedules",
"type": "object",
"properties": {
"fixedDueDateSchedules": {
"description": "List of items",
"id": "fixedDueDateSchedules",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of date ranges for materials checkout and their associated due dates.",
"properties": {
"id": {
"description": "Unique ID (generated UUID)",
"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}$"
},
"name": {
"description": "Schedule name",
"type": "string"
},
"description": {
"description": "Schedule description",
"type": "string"
},
"schedules": {
"id": "schedules",
"description": "List date ranges with a due date for each",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A date range and associated due date, connected with the parent FixedDueDateSchedule.",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"description": "The start of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"to": {
"type": "string",
"format": "date-time",
"description": "The end of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"due": {
"type": "string",
"format": "date-time",
"description": "The due date for materials checked out in the date range between the 'from' and 'to' dates. Conforms to the ISO 8601 date and time format."
}
},
"required": [
"from",
"to",
"due"
],
"additionalProperties": false
}
},
"metadata": {
"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)",
"type": "object",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"fixedDueDateSchedules",
"totalRecords"
]
}
Example:
{
"fixedDueDateSchedules": [
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Fall Semester Due Date Schedule",
"description": "An example fixed due date schedule",
"schedules": [
{
"from": "2017-08-18T17:00:00Z",
"to": "2017-12-14T17:00:00Z",
"due": "2018-01-25T17:00:00Z"
},
{
"from": "2018-08-17T17:00:00Z",
"to": "2018-12-15T17:00:00Z",
"due": "2018-01-23T17:00:00Z"
}
]
},
{
"id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
"name": "Winter Intersession 2017 Due Date Schedule",
"description": "Another example fixed due date schedule",
"schedules": [
{
"from": "2017-12-06T17:00:00Z",
"to": "2018-01-17T17:00:00Z",
"due": "2018-01-28T17:00:00Z"
}
]
}
],
"totalRecords": 2
}
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 fixed-due-date-schedules -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list fixed-due-date-schedules -- unauthorized
Validation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Not implemented yet
Create a new fixed-due-date-schedule item.
POST /fixed-due-date-schedule-storage/fixed-due-date-schedules
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "A set of date ranges for materials checkout and their associated due dates.",
"properties": {
"id": {
"description": "Unique ID (generated UUID)",
"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}$"
},
"name": {
"description": "Schedule name",
"type": "string"
},
"description": {
"description": "Schedule description",
"type": "string"
},
"schedules": {
"id": "schedules",
"description": "List date ranges with a due date for each",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A date range and associated due date, connected with the parent FixedDueDateSchedule.",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"description": "The start of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"to": {
"type": "string",
"format": "date-time",
"description": "The end of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"due": {
"type": "string",
"format": "date-time",
"description": "The due date for materials checked out in the date range between the 'from' and 'to' dates. Conforms to the ISO 8601 date and time format."
}
},
"required": [
"from",
"to",
"due"
],
"additionalProperties": false
}
},
"metadata": {
"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)",
"type": "object",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Fall Semester Due Date Schedule",
"description": "An example fixed due date schedule",
"schedules": [
{
"from": "2017-08-18T17:00:00Z",
"to": "2017-12-14T17:00:00Z",
"due": "2018-01-25T17:00:00Z"
},
{
"from": "2018-08-17T17:00:00Z",
"to": "2018-12-15T17:00:00Z",
"due": "2018-01-23T17:00:00Z"
}
]
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created fixed-due-date-schedule item
Media type: application/json
Type: any
Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Fall Semester Due Date Schedule",
"description": "An example fixed due date schedule",
"schedules": [
{
"from": "2017-08-18T17:00:00Z",
"to": "2017-12-14T17:00:00Z",
"due": "2018-01-25T17:00:00Z"
},
{
"from": "2018-08-17T17:00:00Z",
"to": "2018-12-15T17:00:00Z",
"due": "2018-01-23T17:00:00Z"
}
]
}
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 fixed-due-date-schedule -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create fixed-due-date-schedules -- unauthorized
Validation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Not implemented yet
DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules
All fixed due date schedules deleted
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Not implemented yet
Retrieve fixed-due-date-schedule item with given {fixed-due-date-scheduleId}
GET /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "A set of date ranges for materials checkout and their associated due dates.",
"properties": {
"id": {
"description": "Unique ID (generated UUID)",
"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}$"
},
"name": {
"description": "Schedule name",
"type": "string"
},
"description": {
"description": "Schedule description",
"type": "string"
},
"schedules": {
"id": "schedules",
"description": "List date ranges with a due date for each",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A date range and associated due date, connected with the parent FixedDueDateSchedule.",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"description": "The start of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"to": {
"type": "string",
"format": "date-time",
"description": "The end of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"due": {
"type": "string",
"format": "date-time",
"description": "The due date for materials checked out in the date range between the 'from' and 'to' dates. Conforms to the ISO 8601 date and time format."
}
},
"required": [
"from",
"to",
"due"
],
"additionalProperties": false
}
},
"metadata": {
"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)",
"type": "object",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Fall Semester Due Date Schedule",
"description": "An example fixed due date schedule",
"schedules": [
{
"from": "2017-08-18T17:00:00Z",
"to": "2017-12-14T17:00:00Z",
"due": "2018-01-25T17:00:00Z"
},
{
"from": "2018-08-17T17:00:00Z",
"to": "2018-12-15T17:00:00Z",
"due": "2018-01-23T17:00:00Z"
}
]
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"fixed-due-date-schedule not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Not implemented yet
Update fixed-due-date-schedule item with given {fixed-due-date-scheduleId}
PUT /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "A set of date ranges for materials checkout and their associated due dates.",
"properties": {
"id": {
"description": "Unique ID (generated UUID)",
"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}$"
},
"name": {
"description": "Schedule name",
"type": "string"
},
"description": {
"description": "Schedule description",
"type": "string"
},
"schedules": {
"id": "schedules",
"description": "List date ranges with a due date for each",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A date range and associated due date, connected with the parent FixedDueDateSchedule.",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"description": "The start of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"to": {
"type": "string",
"format": "date-time",
"description": "The end of a date range during which materials checked out will be assigned the due date in the 'due' field. Conforms to the ISO 8601 date and time format."
},
"due": {
"type": "string",
"format": "date-time",
"description": "The due date for materials checked out in the date range between the 'from' and 'to' dates. Conforms to the ISO 8601 date and time format."
}
},
"required": [
"from",
"to",
"due"
],
"additionalProperties": false
}
},
"metadata": {
"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)",
"type": "object",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Fall Semester Due Date Schedule",
"description": "An example fixed due date schedule",
"schedules": [
{
"from": "2017-08-18T17:00:00Z",
"to": "2017-12-14T17:00:00Z",
"due": "2018-01-25T17:00:00Z"
},
{
"from": "2018-08-17T17:00:00Z",
"to": "2018-12-15T17:00:00Z",
"due": "2018-01-23T17:00:00Z"
}
]
}
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 fixed-due-date-schedule -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"fixed-due-date-schedule 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
Not implemented yet
Delete fixed-due-date-schedule item with given {fixed-due-date-scheduleId}
DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
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 fixed-due-date-schedule -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"fixed-due-date-schedule not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Not implemented yet