regis

<back to all web services

AddressAndBioRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressAndBio
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 AddressAndBioRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class AddressAndBioResponse
    {
        public AddressAndBioResponse()
        {
            countriesAndStates = new List<CountriesAndStatesResponse>{};
            prefixes = new List<PrefixResponse>{};
            maritalStatuses = new Dictionary<string, string>{};
            occupations = new List<Occupation>{};
            denominations = new List<Denomination>{};
            ethnicities = new List<Ethnicity>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual PersonExtendedResponse person { get; set; }
        public virtual PersonPictureResponse picture { 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<Occupation> occupations { get; set; }
        public virtual List<Denomination> denominations { get; set; }
        public virtual List<Ethnicity> ethnicities { get; set; }
    }

    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 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 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 PersonPictureResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string imageBase64 { get; set; }
    }

    public partial class PrefixResponse
    {
        public virtual string prefix_code { get; set; }
        public virtual string prefix_name { get; set; }
    }

}

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