Body
Media type: application/json
Type: json
Content:
{ "$schema": "", "description": "A loan type", "type": "object", "properties": { "id": { "type": "string" }, "name": { "description": "label for the loan type", "type": "string" }, "source": { "description": "Origin of the loan type record, e.g. 'System', 'User', 'Consortium' etc.", "type": "string" }, "metadata": { "type": "object", "readonly": true, "$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": [ "name" ]
}Example:
{ "id": "2b94c631-fca9-4892-a730-03ee529ffe27", "name": "Can circulate", "source": "local"
}HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
Body
Media type: application/json
Type: any
Example:
{ "id": "2b94c631-fca9-4892-a730-03ee529ffe27", "name": "Can circulate", "source": "local"
}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 loan-type -- 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 loan-types -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{ "$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": "", "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": "", "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
