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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class PersonLibraryLoginStatusResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    bool? has_library_login;
    bool? is_expired;
    bool? can_create_login;
    bool? created_library_login;
    bool? updated_library_login;
    String? regent_login;
    DateTime? expiry_date;
    String? message;

    PersonLibraryLoginStatusResponse({this.responseStatus,this.has_library_login,this.is_expired,this.can_create_login,this.created_library_login,this.updated_library_login,this.regent_login,this.expiry_date,this.message});
    PersonLibraryLoginStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        has_library_login = json['has_library_login'];
        is_expired = json['is_expired'];
        can_create_login = json['can_create_login'];
        created_library_login = json['created_library_login'];
        updated_library_login = json['updated_library_login'];
        regent_login = json['regent_login'];
        expiry_date = JsonConverters.fromJson(json['expiry_date'],'DateTime',context!);
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'has_library_login': has_library_login,
        'is_expired': is_expired,
        'can_create_login': can_create_login,
        'created_library_login': created_library_login,
        'updated_library_login': updated_library_login,
        'regent_login': regent_login,
        'expiry_date': JsonConverters.toJson(expiry_date,'DateTime',context!),
        'message': message
    };

    getTypeName() => "PersonLibraryLoginStatusResponse";
    TypeContext? context = _ctx;
}

class PersonLibraryLoginCheckRequest implements IConvertible
{
    String? uuid;

    PersonLibraryLoginCheckRequest({this.uuid});
    PersonLibraryLoginCheckRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid
    };

    getTypeName() => "PersonLibraryLoginCheckRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'PersonLibraryLoginStatusResponse': TypeInfo(TypeOf.Class, create:() => PersonLibraryLoginStatusResponse()),
    'PersonLibraryLoginCheckRequest': TypeInfo(TypeOf.Class, create:() => PersonLibraryLoginCheckRequest()),
});

Dart PersonLibraryLoginCheckRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PersonLibraryLoginCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</PersonLibraryLoginCheckRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PersonLibraryLoginStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <can_create_login>false</can_create_login>
  <created_library_login>false</created_library_login>
  <expiry_date>0001-01-01T00:00:00</expiry_date>
  <has_library_login>false</has_library_login>
  <is_expired>false</is_expired>
  <message>String</message>
  <regent_login>String</regent_login>
  <updated_library_login>false</updated_library_login>
</PersonLibraryLoginStatusResponse>