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
"use strict";
export class PersonLibraryLoginStatusResponse {
    /** @param {{responseStatus?:ResponseStatus,has_library_login?:boolean,is_expired?:boolean,can_create_login?:boolean,created_library_login?:boolean,updated_library_login?:boolean,regent_login?:string,expiry_date?:string,message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    has_library_login;
    /** @type {boolean} */
    is_expired;
    /** @type {boolean} */
    can_create_login;
    /** @type {boolean} */
    created_library_login;
    /** @type {boolean} */
    updated_library_login;
    /** @type {string} */
    regent_login;
    /** @type {?string} */
    expiry_date;
    /** @type {string} */
    message;
}
export class PersonLibraryLoginCreateRequest {
    /** @param {{uuid?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript PersonLibraryLoginCreateRequest DTOs

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"}