API docs by Redocly

Reading Room API (1.0.0)

Reading Room API

getReadingRoomsByCqlQuery

Get list of reading rooms based on Cql query

query Parameters
query
string
Default: "cql.allRecords=1"

A query expressed as a CQL string

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 1000

Limit the number of elements returned in the response

includeDeleted
boolean
Default: false

Flag to include the deleted records

Responses

Response samples

Content type
application/json
{
  • "readingRooms": [
    ],
  • "totalRecords": 0
}

create a new reading room

Request Body schema: application/json
required

reading room

id
required
string <UUID>

A unique reading room identifier

name
required
string non-empty

Name of the reading room

isPublic
required
boolean

A flag to determine whether a reading room is public or not

required
Array of objects (ServicePoint) non-empty unique

Service points which are associated to Reading Room

Array (non-empty)
value
required
string <UUID>

A unique service point identifier

label
required
string non-empty

Name of the service point

object (Metadata)

Metadata about creation and changes to records

createdDate
string

Date and time when the record was created

createdByUserId
string <uuid> (common_uuid)
updatedDate
string

Date and time when the record was last updated

updatedByUserId
string <uuid> (common_uuid)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isPublic": true,
  • "servicePoints": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isPublic": true,
  • "servicePoints": [
    ],
  • "metadata": {
    }
}

updateReadingRoomById

Update reading room details

path Parameters
readingRoomId
required
string <uuid> (common_uuid)

Id of the reading room

Request Body schema: application/json
required

reading room

id
required
string <UUID>

A unique reading room identifier

name
required
string non-empty

Name of the reading room

isPublic
required
boolean

A flag to determine whether a reading room is public or not

required
Array of objects (ServicePoint) non-empty unique

Service points which are associated to Reading Room

Array (non-empty)
value
required
string <UUID>

A unique service point identifier

label
required
string non-empty

Name of the service point

object (Metadata)

Metadata about creation and changes to records

createdDate
string

Date and time when the record was created

createdByUserId
string <uuid> (common_uuid)
updatedDate
string

Date and time when the record was last updated

updatedByUserId
string <uuid> (common_uuid)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isPublic": true,
  • "servicePoints": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isPublic": true,
  • "servicePoints": [
    ],
  • "metadata": {
    }
}

deleteReadingRoomById

Delete reading room

path Parameters
readingRoomId
required
string <uuid> (common_uuid)

Id of the reading room

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

create a access log for reading room

path Parameters
readingRoomId
required
string <uuid> (common_uuid)

Id of the reading room

Request Body schema: application/json
required

access Log

id
string <UUID>

A unique access log identifier

readingRoomId
string <UUID>

Id of a reading room

readingRoomName
string

Name of a reading room

servicePointId
string <UUID>

Id of a servicePoint which is associated with the reading room

userId
string <UUID>

Id of a user who allows or denies the user from accessing the reading room

patronId
string <UUID>

Id of a user who wants to access the reading room

action
string
Enum: "ALLOWED" "DENIED"

A field to determine whether a user is allowed to a reading room or not

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "readingRoomId": "string",
  • "readingRoomName": "string",
  • "servicePointId": "string",
  • "userId": "string",
  • "patronId": "string",
  • "action": "ALLOWED"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "readingRoomId": "string",
  • "readingRoomName": "string",
  • "servicePointId": "string",
  • "userId": "string",
  • "patronId": "string",
  • "action": "ALLOWED"
}

Get list of access logs entries based on Cql query

query Parameters
query
string
Default: "cql.allRecords=1"

A query expressed as a CQL string

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 1000

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "accessLogs": [
    ],
  • "totalRecords": 0
}