regis

PersonSearchRequest

**Requires Authentication**
Required permission:	SearchPerson

The following routes are available for this service:
POST	/person/search/page/{Page}
POST	/person/search

namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type PersonSimpleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val ubc_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val uuid:String = null with get,set
        member val regent_login:String = null with get,set
        member val first_name:String = null with get,set
        member val preferred_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val phone_home:String = null with get,set
        member val phone_cell:String = null with get,set
        member val phone_bus:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val code:String = null with get,set
        member val citizenship:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val is_student:Boolean = new Boolean() with get,set
        member val is_faculty:Boolean = new Boolean() with get,set
        member val is_vendor:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PersonSearchResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Persons:ResizeArray<PersonSimpleResponse> = new ResizeArray<PersonSimpleResponse>() with get,set

    [<AllowNullLiteral>]
    type PersonSearchRequest() = 
        member val Page:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val regent_login:String = null with get,set
        member val name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val phone:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# PersonSearchRequest 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/search/page/{Page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0,
	regent_id: 0,
	regent_login: String,
	name: String,
	last_name: String,
	email: String,
	phone: String,
	dob: 0001-01-01
}

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
		}
	},
	persons: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			ubc_id: 0,
			uuid: String,
			regent_login: String,
			first_name: String,
			preferred_name: String,
			middle_name: String,
			last_name: String,
			email: String,
			phone_home: String,
			phone_cell: String,
			phone_bus: String,
			addr1: String,
			addr2: String,
			city: String,
			state: String,
			country: String,
			code: String,
			citizenship: String,
			citizenship_other: String,
			permanent_resident: String,
			dob: 0001-01-01,
			is_student: False,
			is_faculty: False,
			is_vendor: False
		}
	]
}