Users version v1.0

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

patron-pins API

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

/patron-pin

post delete

post

Set the PIN for a user

delete

Remove the PIN for a user

Set the PIN for a user

Body

Media type: application/json

Example:

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

HTTP status code 201

Pin created

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

post

post

Verify the pin posted

Verify the pin posted

Body

Media type: application/json

Example:

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

HTTP status code 200

Pin valid

HTTP status code 422

Pin not valid

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