API docs by Redocly

Edge Users API (v1)

Create a new user

Create a new user

query Parameters
lang
string[a-zA-Z]{2}
Default: "en"
Example: lang=en

Requested language

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Request Body schema: application/json
username
string

A unique name belonging to a user. Typically used for login

id
string

A globally unique (UUID) identifier for the user

externalSystemId
string

An ID that corresponds to an external authority

barcode
string

The library barcode for this user

active
boolean

A flag to determine if a user can log in, take out loans, etc.

blocked
boolean

A flag to determine if the user has manual blocks

type
string

The class of user

patronGroup
string

A UUID corresponding to the group the user belongs to

patronGroupName
string

A group name corresponding to the group the user belongs to

departments
Array of strings (uuid) unique [ items^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... ]

A UUIDs corresponding to the departments the user belongs to

meta
object

Deprecated

proxyFor
Array of strings

Deprecated

object

Personal information about the user

lastName
required
string

The user's surname

firstName
string

The user's given name

middleName
string

The user's middle name (if any)

preferredFirstName
string

The user's preferred name

email
string

The user's email address

phone
string

The user's primary phone number

mobilePhone
string

The user's mobile phone number

dateOfBirth
string <date-time>

The user's birth date

Array of objects >= 0 items

Physical addresses associated with the user

preferredContactTypeId
string

Id of user's preferred contact type

enrollmentDate
string <date-time>

The date in which the user joined the organization

expirationDate
string <date-time>

The date for when the user becomes inactive

createdDate
string <date-time>

Deprecated

updatedDate
string <date-time>

Deprecated

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

object (tags)

List of simple tags that can be added to an object

tagList
Array of strings

List of tags

object

Object that contains custom field

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "id": "string",
  • "externalSystemId": "string",
  • "barcode": "string",
  • "active": true,
  • "blocked": true,
  • "type": "string",
  • "patronGroup": "string",
  • "patronGroupName": "string",
  • "departments": [
    ],
  • "meta": { },
  • "proxyFor": [
    ],
  • "personal": {
    },
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "tags": {
    },
  • "customFields": { }
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "id": "string",
  • "externalSystemId": "string",
  • "barcode": "string",
  • "active": true,
  • "blocked": true,
  • "type": "string",
  • "patronGroup": "string",
  • "patronGroupName": "string",
  • "departments": [
    ],
  • "meta": { },
  • "proxyFor": [
    ],
  • "personal": {
    },
  • "enrollmentDate": "2019-08-24T14:15:22Z",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "tags": {
    },
  • "customFields": { }
}

Retrieve users collection

Retrieve users collection

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

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

Returns an indication whether the specified user exists or not

Returns an indication whether the specified user exists or not

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "errorMessage": "Validation error"
}

Set the PIN for a user

Set the PIN for a user

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Request Body schema: application/json
id
required
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

UUID

pin
required
string

PIN of the user

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "errorMessage": "Validation error"
}

Verify patron PIN

Verify the PIN for a user

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Request Body schema: application/json
id
required
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

UUID

pin
required
string

PIN of the user

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "errorMessage": "Validation error"
}