regis

<back to all web services

PersonLibraryLoginCreateRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/{uuid}/library-login/create
PersonLibraryLoginCreateRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
authorizing_uuidbodystringNo
PersonLibraryLoginStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
has_library_loginformboolNo
is_expiredformboolNo
can_create_loginformboolNo
created_library_loginformboolNo
updated_library_loginformboolNo
regent_loginformstringNo
expiry_dateformDateTime?No
messageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/{uuid}/library-login/create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","message":"String"}