regis

<back to all web services

PersonBaseValuesRequest

export class PersonExtendedResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public ubc_id?: number;
    public spouse_regent_id?: number;
    public uuid: string;
    public regent_login: string;
    public spouse_rwl: string;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public override_transcript_name: string;
    public spouse_name: string;
    public addr1: string;
    public addr2: string;
    public country: string;
    public state: string;
    public city: string;
    public code: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public prefix: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public denomination: string;
    public occupation: string;
    public ethnicity: string;
    public gender: string;
    public marital_status: string;
    public deceased_date?: string;
    public is_donor: boolean;
    public is_vendor: boolean;
    public is_gp_customer: boolean;
    public crm_student_status: string;
    public crm_assigned: string;
    public last_registered_term: string;
    public is_regent_staff: boolean;
    public regent_title: string;
    public regent_department: string;
    public regent_faculty_profile_url: string;
    public regent_image_url: string;
    public include_on_website: boolean;
    public added_by: string;
    public added_date?: string;
    public last_changed_by: string;
    public last_changed_date?: string;
    public addr_last_changed_by: string;
    public addr_last_changed_date?: string;
    public tax_number: string;
    public regent_current_program: string;
    public regent_degrees: string;

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

export class CountriesAndStatesResponse
{
    public country_code: string;
    public country_name: string;
    public states: { [index: string]: string; };

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

export class PrefixResponse
{
    public prefix_code: string;
    public prefix_name: string;

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

export class Denomination
{
    public id: number;
    public code: string;
    public denomination_name: string;

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

export class Occupation
{
    public id: number;
    public code: string;
    public occupation_name: string;

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

export class Ethnicity
{
    public id: number;
    public code: string;
    public ethnicity_name: string;

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

export class PersonBaseValuesResponse
{
    public responseStatus: ResponseStatus;
    public person: PersonExtendedResponse;
    public countriesAndStates: CountriesAndStatesResponse[];
    public prefixes: PrefixResponse[];
    public maritalStatuses: { [index: string]: string; };
    public denominations: Denomination[];
    public occupations: Occupation[];
    public ethnicities: Ethnicity[];

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

export class PersonBaseValuesRequest
{

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

TypeScript PersonBaseValuesRequest DTOs

POST /person/baseValues HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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
		}
	},
	person: 
	{
		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
	},
	countriesAndStates: 
	[
		{
			country_code: String,
			country_name: String,
			states: 
			{
				String: String
			}
		}
	],
	prefixes: 
	[
		{
			prefix_code: String,
			prefix_name: String
		}
	],
	maritalStatuses: 
	{
		String: String
	},
	denominations: 
	[
		{
			id: 0,
			code: String,
			denomination_name: String
		}
	],
	occupations: 
	[
		{
			id: 0,
			code: String,
			occupation_name: String
		}
	],
	ethnicities: 
	[
		{
			id: 0,
			code: String,
			ethnicity_name: String
		}
	]
}