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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class AddressAndBioUpdateResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    bool? update_success;
    List<String>? messages;

    AddressAndBioUpdateResponse({this.responseStatus,this.update_success,this.messages});
    AddressAndBioUpdateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        update_success = json['update_success'];
        messages = JsonConverters.fromJson(json['messages'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'update_success': update_success,
        'messages': JsonConverters.toJson(messages,'List<String>',context!)
    };

    getTypeName() => "AddressAndBioUpdateResponse";
    TypeContext? context = _ctx;
}

class AddressAndBioUpdateRequest implements IConvertible
{
    String? uuid;
    int? spouse_regent_id;
    String? 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;
    DateTime? dob;
    String? citizenship;
    String? citizenship_other;
    String? permanent_resident;
    String? denomination;
    String? occupation;
    String? ethnicity;
    String? gender;
    String? marital_status;
    DateTime? deceased_date;
    String? tax_number;
    bool? update_re_and_sugar;
    String? regent_title;
    String? regent_department;
    String? regent_faculty_profile_url;
    String? regent_image_url;
    bool? include_on_website;
    String? authorizing_uuid;

    AddressAndBioUpdateRequest({this.uuid,this.spouse_regent_id,this.first_name,this.middle_name,this.last_name,this.preferred_name,this.birth_name,this.addr1,this.addr2,this.country,this.state,this.city,this.code,this.phone_home,this.phone_cell,this.phone_bus,this.email,this.prefix,this.dob,this.citizenship,this.citizenship_other,this.permanent_resident,this.denomination,this.occupation,this.ethnicity,this.gender,this.marital_status,this.deceased_date,this.tax_number,this.update_re_and_sugar,this.regent_title,this.regent_department,this.regent_faculty_profile_url,this.regent_image_url,this.include_on_website,this.authorizing_uuid});
    AddressAndBioUpdateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        spouse_regent_id = json['spouse_regent_id'];
        first_name = json['first_name'];
        middle_name = json['middle_name'];
        last_name = json['last_name'];
        preferred_name = json['preferred_name'];
        birth_name = json['birth_name'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        country = json['country'];
        state = json['state'];
        city = json['city'];
        code = json['code'];
        phone_home = json['phone_home'];
        phone_cell = json['phone_cell'];
        phone_bus = json['phone_bus'];
        email = json['email'];
        prefix = json['prefix'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        denomination = json['denomination'];
        occupation = json['occupation'];
        ethnicity = json['ethnicity'];
        gender = json['gender'];
        marital_status = json['marital_status'];
        deceased_date = JsonConverters.fromJson(json['deceased_date'],'DateTime',context!);
        tax_number = json['tax_number'];
        update_re_and_sugar = json['update_re_and_sugar'];
        regent_title = json['regent_title'];
        regent_department = json['regent_department'];
        regent_faculty_profile_url = json['regent_faculty_profile_url'];
        regent_image_url = json['regent_image_url'];
        include_on_website = json['include_on_website'];
        authorizing_uuid = json['authorizing_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'spouse_regent_id': spouse_regent_id,
        'first_name': first_name,
        'middle_name': middle_name,
        'last_name': last_name,
        'preferred_name': preferred_name,
        'birth_name': birth_name,
        'addr1': addr1,
        'addr2': addr2,
        'country': country,
        'state': state,
        'city': city,
        'code': code,
        'phone_home': phone_home,
        'phone_cell': phone_cell,
        'phone_bus': phone_bus,
        'email': email,
        'prefix': prefix,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'denomination': denomination,
        'occupation': occupation,
        'ethnicity': ethnicity,
        'gender': gender,
        'marital_status': marital_status,
        'deceased_date': JsonConverters.toJson(deceased_date,'DateTime',context!),
        'tax_number': tax_number,
        'update_re_and_sugar': update_re_and_sugar,
        'regent_title': regent_title,
        'regent_department': regent_department,
        'regent_faculty_profile_url': regent_faculty_profile_url,
        'regent_image_url': regent_image_url,
        'include_on_website': include_on_website,
        'authorizing_uuid': authorizing_uuid
    };

    getTypeName() => "AddressAndBioUpdateRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'AddressAndBioUpdateResponse': TypeInfo(TypeOf.Class, create:() => AddressAndBioUpdateResponse()),
    'AddressAndBioUpdateRequest': TypeInfo(TypeOf.Class, create:() => AddressAndBioUpdateRequest()),
});

Dart 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
	]
}