regis

<back to all web services

PersonLibraryLoginCheckRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/{uuid}/library-login/check

export class PersonLibraryLoginStatusResponse
{
    public responseStatus: ResponseStatus;
    public has_library_login: boolean;
    public is_expired: boolean;
    public can_create_login: boolean;
    public created_library_login: boolean;
    public updated_library_login: boolean;
    public regent_login: string;
    public expiry_date?: string;
    public message: string;

    public constructor(init?: Partial<PersonLibraryLoginStatusResponse>) { (Object as any).assign(this, init); }
}

export class PersonLibraryLoginCheckRequest
{
    public uuid: string;

    public constructor(init?: Partial<PersonLibraryLoginCheckRequest>) { (Object as any).assign(this, init); }
}

TypeScript PersonLibraryLoginCheckRequest 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/check HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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