regis

AddressAndBioRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/{uuid}/addressAndBio

import Foundation
import ServiceStack

public class AddressAndBioRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class AddressAndBioResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var person:PersonExtendedResponse
    public var picture:PersonPictureResponse
    public var countriesAndStates:[CountriesAndStatesResponse] = []
    public var prefixes:[PrefixResponse] = []
    public var maritalStatuses:[String:String] = [:]
    public var occupations:[Occupation] = []
    public var denominations:[Denomination] = []
    public var ethnicities:[Ethnicity] = []

    required public init(){}
}

public class PersonExtendedResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var ubc_id:Int?
    public var spouse_regent_id:Int?
    public var uuid:String
    public var regent_login:String
    public var spouse_rwl:String
    public var first_name:String
    public var middle_name:String
    public var last_name:String
    public var preferred_name:String
    public var birth_name:String
    public var override_transcript_name:String
    public var spouse_name:String
    public var addr1:String
    public var addr2:String
    public var country:String
    public var state:String
    public var city:String
    public var code:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var email:String
    public var `prefix`:String
    public var dob:Date?
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var denomination:String
    public var occupation:String
    public var ethnicity:String
    public var gender:String
    public var marital_status:String
    public var deceased_date:Date?
    public var is_donor:Bool
    public var is_vendor:Bool
    public var is_gp_customer:Bool
    public var crm_student_status:String
    public var crm_assigned:String
    public var last_registered_term:String
    public var is_regent_staff:Bool
    public var regent_title:String
    public var regent_department:String
    public var regent_faculty_profile_url:String
    public var regent_image_url:String
    public var include_on_website:Bool
    public var added_by:String
    public var added_date:Date?
    public var last_changed_by:String
    public var last_changed_date:Date?
    public var addr_last_changed_by:String
    public var addr_last_changed_date:Date?
    public var tax_number:String
    public var regent_current_program:String
    public var regent_degrees:String

    required public init(){}
}

public class PersonPictureResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var imageBase64:String

    required public init(){}
}

public class CountriesAndStatesResponse : Codable
{
    public var country_code:String
    public var country_name:String
    public var states:[String:String] = [:]

    required public init(){}
}

public class PrefixResponse : Codable
{
    public var prefix_code:String
    public var prefix_name:String

    required public init(){}
}

public class Occupation : Codable
{
    public var id:Int
    public var code:String
    public var occupation_name:String

    required public init(){}
}

public class Denomination : Codable
{
    public var id:Int
    public var code:String
    public var denomination_name:String

    required public init(){}
}

public class Ethnicity : Codable
{
    public var id:Int
    public var code:String
    public var ethnicity_name:String

    required public init(){}
}

Swift AddressAndBioRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/{uuid}/addressAndBio HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddressAndBioRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</AddressAndBioRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddressAndBioResponse 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>
    <include_on_website>false</include_on_website>
    <is_donor>false</is_donor>
    <is_gp_customer>false</is_gp_customer>
    <is_regent_staff>false</is_regent_staff>
    <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_department>String</regent_department>
    <regent_faculty_profile_url>String</regent_faculty_profile_url>
    <regent_id>0</regent_id>
    <regent_image_url>String</regent_image_url>
    <regent_login>String</regent_login>
    <regent_title>String</regent_title>
    <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>
  <picture>
    <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>
    <imageBase64>String</imageBase64>
  </picture>
  <prefixes>
    <PrefixResponse>
      <prefix_code>String</prefix_code>
      <prefix_name>String</prefix_name>
    </PrefixResponse>
  </prefixes>
</AddressAndBioResponse>