Checkout lock storage
get
Retrieve a list of checkout lock items
post
Create a lock for the given userid
get /check-out-lock-storage
Retrieve a list of checkout lock items
Query Parameters
- userId: required(string)
Filter locks by user ID.
- offset: required(integer)
The number of items to skip in the result set.
- limit: required(integer)
The maximum number of locks to return.
HTTP status code 200
Returns a list of checkout lock items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of checkoutLocks",
"type": "object",
"properties": {
"checkoutLocks": {
"description": "List of checkoutLocks",
"id": "checkoutLocks",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Checkout Lock",
"properties": {
"id": {
"description": "ID of the lock",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"userId": {
"description": "ID of the patron the lock is created for",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"creationDate": {
"description": "Date and time of lock creation",
"type": "string",
"format": "date-time"
}
}
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"checkoutLocks",
"totalRecords"
]
}HTTP status code 422
Invalid Parameters
Body
Media type: text/plain
Type: any
Example:
Invalid Parameterspost /check-out-lock-storage
Create a lock for the given userid
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Checkout Lock",
"properties": {
"userId": {
"description": "ID of the patron the lock is created for",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"ttlMs": {
"description": "Time to live for lock object",
"type": "integer"
}
}
}Example:
{
"userId": "77477611-ab44-4082-a0d8-42f7acdfde11",
"ttl": 3000
}
HTTP status code 201
Checkout lock is created
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Checkout Lock",
"properties": {
"id": {
"description": "ID of the lock",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"userId": {
"description": "ID of the patron the lock is created for",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"creationDate": {
"description": "Date and time of lock creation",
"type": "string",
"format": "date-time"
}
}
}Example:
{
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434379",
"userId": "77477611-ab44-4082-a0d8-42f7acdfde11",
"creationDate": "2018-01-31T21:21:02Z"
}
HTTP status code 400
Bad Request
Body
Media type: text/plain
Type: any
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
Body
Media type: text/plain
Type: any
Example:
Internal server errorHTTP status code 503
Failed to create lock for patron {userId}
Body
Media type: text/plain
Type: any
Example:
Failed to create lock for patron get
Get checkout lock
delete
Delete checkout lock
get /check-out-lock-storage/{lockId}
Get checkout lock
URI Parameters
- lockId: required(string)
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#",
"type": "object",
"description": "Checkout Lock",
"properties": {
"id": {
"description": "ID of the lock",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"userId": {
"description": "ID of the patron the lock is created for",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"creationDate": {
"description": "Date and time of lock creation",
"type": "string",
"format": "date-time"
}
}
}Example:
{
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434379",
"userId": "77477611-ab44-4082-a0d8-42f7acdfde11",
"creationDate": "2018-01-31T21:21:02Z"
}
HTTP status code 400
Bad Request
Body
Media type: text/plain
Type: any
HTTP status code 404
Item with a given ID not found