| Required permission: | ReadPersonBaseValues |
| POST | /person/baseValues |
|---|
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;
using regis.ClassLibrary.DatabaseModels.REGIS;
namespace regis.ClassLibrary.DatabaseModels.REGIS
{
public partial class Denomination
{
public virtual int id { get; set; }
public virtual string code { get; set; }
public virtual string denomination_name { get; set; }
}
public partial class Ethnicity
{
public virtual int id { get; set; }
public virtual string code { get; set; }
public virtual string ethnicity_name { get; set; }
}
public partial class Occupation
{
public virtual int id { get; set; }
public virtual string code { get; set; }
public virtual string occupation_name { get; set; }
}
}
namespace regis.ClassLibrary.Requests
{
public partial class PersonBaseValuesRequest
{
}
}
namespace regis.ClassLibrary.Responses
{
public partial class CountriesAndStatesResponse
{
public CountriesAndStatesResponse()
{
states = new Dictionary<string, string>{};
}
public virtual string country_code { get; set; }
public virtual string country_name { get; set; }
public virtual Dictionary<string, string> states { get; set; }
}
public partial class PersonBaseValuesResponse
{
public PersonBaseValuesResponse()
{
countriesAndStates = new List<CountriesAndStatesResponse>{};
prefixes = new List<PrefixResponse>{};
maritalStatuses = new Dictionary<string, string>{};
denominations = new List<Denomination>{};
occupations = new List<Occupation>{};
ethnicities = new List<Ethnicity>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual PersonExtendedResponse person { get; set; }
public virtual List<CountriesAndStatesResponse> countriesAndStates { get; set; }
public virtual List<PrefixResponse> prefixes { get; set; }
public virtual Dictionary<string, string> maritalStatuses { get; set; }
public virtual List<Denomination> denominations { get; set; }
public virtual List<Occupation> occupations { get; set; }
public virtual List<Ethnicity> ethnicities { get; set; }
}
public partial class PersonExtendedResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual int regent_id { get; set; }
public virtual int? ubc_id { get; set; }
public virtual int? spouse_regent_id { get; set; }
public virtual string uuid { get; set; }
public virtual string regent_login { get; set; }
public virtual string spouse_rwl { 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 override_transcript_name { get; set; }
public virtual string spouse_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 bool is_donor { get; set; }
public virtual bool is_vendor { get; set; }
public virtual bool is_gp_customer { get; set; }
public virtual string crm_student_status { get; set; }
public virtual string crm_assigned { get; set; }
public virtual string last_registered_term { get; set; }
public virtual bool is_regent_staff { 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 added_by { get; set; }
public virtual DateTime? added_date { get; set; }
public virtual string last_changed_by { get; set; }
public virtual DateTime? last_changed_date { get; set; }
public virtual string addr_last_changed_by { get; set; }
public virtual DateTime? addr_last_changed_date { get; set; }
public virtual string tax_number { get; set; }
public virtual string regent_current_program { get; set; }
public virtual string regent_degrees { get; set; }
}
public partial class PrefixResponse
{
public virtual string prefix_code { get; set; }
public virtual string prefix_name { get; set; }
}
}
C# PersonBaseValuesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
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
}
]
}