| Required permission: | ReadPersonBaseValues |
| POST | /person/baseValues |
|---|
namespace regis.ClassLibrary.DatabaseModels.REGIS
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type PersonExtendedResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val ubc_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val spouse_regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val uuid:String = null with get,set
member val regent_login:String = null with get,set
member val spouse_rwl:String = null with get,set
member val first_name:String = null with get,set
member val middle_name:String = null with get,set
member val last_name:String = null with get,set
member val preferred_name:String = null with get,set
member val birth_name:String = null with get,set
member val override_transcript_name:String = null with get,set
member val spouse_name:String = null with get,set
member val addr1:String = null with get,set
member val addr2:String = null with get,set
member val country:String = null with get,set
member val state:String = null with get,set
member val city:String = null with get,set
member val code:String = null with get,set
member val phone_home:String = null with get,set
member val phone_cell:String = null with get,set
member val phone_bus:String = null with get,set
member val email:String = null with get,set
member val prefix:String = null with get,set
member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val citizenship:String = null with get,set
member val citizenship_other:String = null with get,set
member val permanent_resident:String = null with get,set
member val denomination:String = null with get,set
member val occupation:String = null with get,set
member val ethnicity:String = null with get,set
member val gender:String = null with get,set
member val marital_status:String = null with get,set
member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val is_donor:Boolean = new Boolean() with get,set
member val is_vendor:Boolean = new Boolean() with get,set
member val is_gp_customer:Boolean = new Boolean() with get,set
member val crm_student_status:String = null with get,set
member val crm_assigned:String = null with get,set
member val last_registered_term:String = null with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val last_changed_by:String = null with get,set
member val last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val addr_last_changed_by:String = null with get,set
member val addr_last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val tax_number:String = null with get,set
member val regent_current_program:String = null with get,set
member val regent_degrees:String = null with get,set
[<AllowNullLiteral>]
type CountriesAndStatesResponse() =
member val country_code:String = null with get,set
member val country_name:String = null with get,set
member val states:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type PrefixResponse() =
member val prefix_code:String = null with get,set
member val prefix_name:String = null with get,set
[<AllowNullLiteral>]
type Denomination() =
member val id:Int32 = new Int32() with get,set
member val code:String = null with get,set
member val denomination_name:String = null with get,set
[<AllowNullLiteral>]
type Occupation() =
member val id:Int32 = new Int32() with get,set
member val code:String = null with get,set
member val occupation_name:String = null with get,set
[<AllowNullLiteral>]
type Ethnicity() =
member val id:Int32 = new Int32() with get,set
member val code:String = null with get,set
member val ethnicity_name:String = null with get,set
[<AllowNullLiteral>]
type PersonBaseValuesResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val person:PersonExtendedResponse = null with get,set
member val countriesAndStates:ResizeArray<CountriesAndStatesResponse> = new ResizeArray<CountriesAndStatesResponse>() with get,set
member val prefixes:ResizeArray<PrefixResponse> = new ResizeArray<PrefixResponse>() with get,set
member val maritalStatuses:Dictionary<String, String> = new Dictionary<String, String>() with get,set
member val denominations:ResizeArray<Denomination> = new ResizeArray<Denomination>() with get,set
member val occupations:ResizeArray<Occupation> = new ResizeArray<Occupation>() with get,set
member val ethnicities:ResizeArray<Ethnicity> = new ResizeArray<Ethnicity>() with get,set
[<AllowNullLiteral>]
type PersonBaseValuesRequest() =
class end
F# PersonBaseValuesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PersonBaseValuesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PersonBaseValuesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<countriesAndStates>
<CountriesAndStatesResponse>
<country_code>String</country_code>
<country_name>String</country_name>
<states xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</states>
</CountriesAndStatesResponse>
</countriesAndStates>
<denominations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
<d2p1:Denomination>
<d2p1:code>String</d2p1:code>
<d2p1:denomination_name>String</d2p1:denomination_name>
<d2p1:id>0</d2p1:id>
</d2p1:Denomination>
</denominations>
<ethnicities xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
<d2p1:Ethnicity>
<d2p1:code>String</d2p1:code>
<d2p1:ethnicity_name>String</d2p1:ethnicity_name>
<d2p1:id>0</d2p1:id>
</d2p1:Ethnicity>
</ethnicities>
<maritalStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</maritalStatuses>
<occupations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
<d2p1:Occupation>
<d2p1:code>String</d2p1:code>
<d2p1:id>0</d2p1:id>
<d2p1:occupation_name>String</d2p1:occupation_name>
</d2p1:Occupation>
</occupations>
<person>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<addr1>String</addr1>
<addr2>String</addr2>
<addr_last_changed_by>String</addr_last_changed_by>
<addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
<birth_name>String</birth_name>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<city>String</city>
<code>String</code>
<country>String</country>
<crm_assigned>String</crm_assigned>
<crm_student_status>String</crm_student_status>
<deceased_date>0001-01-01T00:00:00</deceased_date>
<denomination>String</denomination>
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<ethnicity>String</ethnicity>
<first_name>String</first_name>
<gender>String</gender>
<is_donor>false</is_donor>
<is_gp_customer>false</is_gp_customer>
<is_vendor>false</is_vendor>
<last_changed_by>String</last_changed_by>
<last_changed_date>0001-01-01T00:00:00</last_changed_date>
<last_name>String</last_name>
<last_registered_term>String</last_registered_term>
<marital_status>String</marital_status>
<middle_name>String</middle_name>
<occupation>String</occupation>
<override_transcript_name>String</override_transcript_name>
<permanent_resident>String</permanent_resident>
<phone_bus>String</phone_bus>
<phone_cell>String</phone_cell>
<phone_home>String</phone_home>
<preferred_name>String</preferred_name>
<prefix>String</prefix>
<regent_current_program>String</regent_current_program>
<regent_degrees>String</regent_degrees>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
<spouse_name>String</spouse_name>
<spouse_regent_id>0</spouse_regent_id>
<spouse_rwl>String</spouse_rwl>
<state>String</state>
<tax_number>String</tax_number>
<ubc_id>0</ubc_id>
<uuid>String</uuid>
</person>
<prefixes>
<PrefixResponse>
<prefix_code>String</prefix_code>
<prefix_name>String</prefix_name>
</PrefixResponse>
</prefixes>
</PersonBaseValuesResponse>