regis

<back to all web services

AddressAndBioUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressandbio/update

export class AddressAndBioUpdateResponse
{
    public responseStatus: ResponseStatus;
    public update_success: boolean;
    public messages: string[];

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

export class AddressAndBioUpdateRequest
{
    public uuid: string;
    public spouse_regent_id?: number;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_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 tax_number: string;
    public update_re_and_sugar: 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 authorizing_uuid: string;

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

TypeScript AddressAndBioUpdateRequest 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}/addressandbio/update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	spouse_regent_id: 0,
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	birth_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,
	tax_number: String,
	update_re_and_sugar: False,
	regent_title: String,
	regent_department: String,
	regent_faculty_profile_url: String,
	regent_image_url: String,
	include_on_website: False,
	authorizing_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
		}
	},
	update_success: False,
	messages: 
	[
		String
	]
}