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
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PersonLibraryLoginStatusResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val has_library_login:Boolean = new Boolean() with get,set
        member val is_expired:Boolean = new Boolean() with get,set
        member val can_create_login:Boolean = new Boolean() with get,set
        member val created_library_login:Boolean = new Boolean() with get,set
        member val updated_library_login:Boolean = new Boolean() with get,set
        member val regent_login:String = null with get,set
        member val expiry_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val message:String = null with get,set

    [<AllowNullLiteral>]
    type PersonLibraryLoginCheckRequest() = 
        member val uuid:String = null with get,set

F# PersonLibraryLoginCheckRequest DTOs

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

HTTP + 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
}