Users (v1.0)

http://github.com/org/folio/mod-users

Table of contents

patron-pins API

This documents the API calls that can be made to set and verify patron pins

/patron-pin

POST /patron-pin

Set the PIN for a user

POST /patron-pin
Body

Media type: application/json

Example:

{
  "id": "7261ecaae3a74dc68b468e12a70b1aec",
  "pin": "1234"
}

Response 201

Pin created

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

DELETE /patron-pin

Remove the PIN for a user

DELETE /patron-pin
Body

Media type: application/json

Example:

{
  "id": "7261ecaae3a74dc68b468e12a70b1aec"
}

Response 200

Pin removed

Response 422

Pin not valid

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

POST /patron-pin/verify

Verify the pin posted

POST /patron-pin/verify
Body

Media type: application/json

Example:

{
  "id": "7261ecaae3a74dc68b468e12a70b1aec",
  "pin": "1234"
}

Response 200

Pin valid

Response 422

Pin not valid

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator