regis

<back to all web services

PersonExtendedRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/{uuid}/extended
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type PersonExtendedResponse() = 
        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 spouse_regent_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 spouse_rwl:String = null with get,set
        member val first_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 preferred_name:String = null with get,set
        member val birth_name:String = null with get,set
        member val override_transcript_name:String = null with get,set
        member val spouse_name:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val country:String = null with get,set
        member val state:String = null with get,set
        member val city:String = null with get,set
        member val code: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 email:String = null with get,set
        member val prefix:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() 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 denomination:String = null with get,set
        member val occupation:String = null with get,set
        member val ethnicity:String = null with get,set
        member val gender:String = null with get,set
        member val marital_status:String = null with get,set
        member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val is_donor:Boolean = new Boolean() with get,set
        member val is_vendor:Boolean = new Boolean() with get,set
        member val is_gp_customer:Boolean = new Boolean() with get,set
        member val crm_student_status:String = null with get,set
        member val crm_assigned:String = null with get,set
        member val last_registered_term:String = null with get,set
        member val is_regent_staff:Boolean = new Boolean() with get,set
        member val regent_title:String = null with get,set
        member val regent_department:String = null with get,set
        member val regent_faculty_profile_url:String = null with get,set
        member val regent_image_url:String = null with get,set
        member val include_on_website:Boolean = new Boolean() with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_changed_by:String = null with get,set
        member val last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val addr_last_changed_by:String = null with get,set
        member val addr_last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val tax_number:String = null with get,set
        member val regent_current_program:String = null with get,set
        member val regent_degrees:String = null with get,set

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

F# PersonExtendedRequest 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}/extended 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
		}
	},
	regent_id: 0,
	ubc_id: 0,
	spouse_regent_id: 0,
	uuid: String,
	regent_login: String,
	spouse_rwl: String,
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	birth_name: String,
	override_transcript_name: String,
	spouse_name: String,
	addr1: String,
	addr2: String,
	country: String,
	state: String,
	city: String,
	code: String,
	phone_home: String,
	phone_cell: String,
	phone_bus: String,
	email: String,
	prefix: String,
	dob: 0001-01-01,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	denomination: String,
	occupation: String,
	ethnicity: String,
	gender: String,
	marital_status: String,
	deceased_date: 0001-01-01,
	is_donor: False,
	is_vendor: False,
	is_gp_customer: False,
	crm_student_status: String,
	crm_assigned: String,
	last_registered_term: String,
	is_regent_staff: False,
	regent_title: String,
	regent_department: String,
	regent_faculty_profile_url: String,
	regent_image_url: String,
	include_on_website: False,
	added_by: String,
	added_date: 0001-01-01,
	last_changed_by: String,
	last_changed_date: 0001-01-01,
	addr_last_changed_by: String,
	addr_last_changed_date: 0001-01-01,
	tax_number: String,
	regent_current_program: String,
	regent_degrees: String
}