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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class AddressAndBioUpdateRequest
    {
        public virtual string uuid { get; set; }
        public virtual int? spouse_regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string birth_name { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string country { get; set; }
        public virtual string state { get; set; }
        public virtual string city { get; set; }
        public virtual string code { get; set; }
        public virtual string phone_home { get; set; }
        public virtual string phone_cell { get; set; }
        public virtual string phone_bus { get; set; }
        public virtual string email { get; set; }
        public virtual string prefix { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual string denomination { get; set; }
        public virtual string occupation { get; set; }
        public virtual string ethnicity { get; set; }
        public virtual string gender { get; set; }
        public virtual string marital_status { get; set; }
        public virtual DateTime? deceased_date { get; set; }
        public virtual string tax_number { get; set; }
        public virtual bool update_re_and_sugar { get; set; }
        public virtual string regent_title { get; set; }
        public virtual string regent_department { get; set; }
        public virtual string regent_faculty_profile_url { get; set; }
        public virtual string regent_image_url { get; set; }
        public virtual bool include_on_website { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class AddressAndBioUpdateResponse
    {
        public AddressAndBioUpdateResponse()
        {
            messages = new List<string>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual bool update_success { get; set; }
        public virtual List<string> messages { get; set; }
    }

}

C# 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
	]
}