| Required permission: | SearchPerson |
| POST | /person/{uuid}/library-login/check |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| has_library_login | form | bool | No | |
| is_expired | form | bool | No | |
| can_create_login | form | bool | No | |
| created_library_login | form | bool | No | |
| updated_library_login | form | bool | No | |
| regent_login | form | string | No | |
| expiry_date | form | DateTime? | No | |
| message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/library-login/check HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
has_library_login: False,
is_expired: False,
can_create_login: False,
created_library_login: False,
updated_library_login: False,
regent_login: String,
expiry_date: 0001-01-01,
message: String
}