regis

AddressAndBioRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class PersonExtendedResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,spouse_regent_id?:number,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?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,denomination?:string,occupation?:string,ethnicity?:string,gender?:string,marital_status?:string,deceased_date?:string,is_donor?:boolean,is_vendor?:boolean,is_gp_customer?:boolean,crm_student_status?:string,crm_assigned?:string,last_registered_term?:string,is_regent_staff?:boolean,regent_title?:string,regent_department?:string,regent_faculty_profile_url?:string,regent_image_url?:string,include_on_website?:boolean,added_by?:string,added_date?:string,last_changed_by?:string,last_changed_date?:string,addr_last_changed_by?:string,addr_last_changed_date?:string,tax_number?:string,regent_current_program?:string,regent_degrees?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    ubc_id;
    /** @type {?number} */
    spouse_regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    spouse_rwl;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    override_transcript_name;
    /** @type {string} */
    spouse_name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    country;
    /** @type {string} */
    state;
    /** @type {string} */
    city;
    /** @type {string} */
    code;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    email;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    denomination;
    /** @type {string} */
    occupation;
    /** @type {string} */
    ethnicity;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {?string} */
    deceased_date;
    /** @type {boolean} */
    is_donor;
    /** @type {boolean} */
    is_vendor;
    /** @type {boolean} */
    is_gp_customer;
    /** @type {string} */
    crm_student_status;
    /** @type {string} */
    crm_assigned;
    /** @type {string} */
    last_registered_term;
    /** @type {boolean} */
    is_regent_staff;
    /** @type {string} */
    regent_title;
    /** @type {string} */
    regent_department;
    /** @type {string} */
    regent_faculty_profile_url;
    /** @type {string} */
    regent_image_url;
    /** @type {boolean} */
    include_on_website;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    last_changed_by;
    /** @type {?string} */
    last_changed_date;
    /** @type {string} */
    addr_last_changed_by;
    /** @type {?string} */
    addr_last_changed_date;
    /** @type {string} */
    tax_number;
    /** @type {string} */
    regent_current_program;
    /** @type {string} */
    regent_degrees;
}
export class PersonPictureResponse {
    /** @param {{responseStatus?:ResponseStatus,imageBase64?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    imageBase64;
}
export class CountriesAndStatesResponse {
    /** @param {{country_code?:string,country_name?:string,states?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    country_code;
    /** @type {string} */
    country_name;
    /** @type {{ [index: string]: string; }} */
    states;
}
export class PrefixResponse {
    /** @param {{prefix_code?:string,prefix_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    prefix_code;
    /** @type {string} */
    prefix_name;
}
export class Occupation {
    /** @param {{id?:number,code?:string,occupation_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    code;
    /** @type {string} */
    occupation_name;
}
export class Denomination {
    /** @param {{id?:number,code?:string,denomination_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    code;
    /** @type {string} */
    denomination_name;
}
export class Ethnicity {
    /** @param {{id?:number,code?:string,ethnicity_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    code;
    /** @type {string} */
    ethnicity_name;
}
export class AddressAndBioResponse {
    /** @param {{responseStatus?:ResponseStatus,person?:PersonExtendedResponse,picture?:PersonPictureResponse,countriesAndStates?:CountriesAndStatesResponse[],prefixes?:PrefixResponse[],maritalStatuses?:{ [index: string]: string; },occupations?:Occupation[],denominations?:Denomination[],ethnicities?:Ethnicity[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {PersonExtendedResponse} */
    person;
    /** @type {PersonPictureResponse} */
    picture;
    /** @type {CountriesAndStatesResponse[]} */
    countriesAndStates;
    /** @type {PrefixResponse[]} */
    prefixes;
    /** @type {{ [index: string]: string; }} */
    maritalStatuses;
    /** @type {Occupation[]} */
    occupations;
    /** @type {Denomination[]} */
    denominations;
    /** @type {Ethnicity[]} */
    ethnicities;
}
export class AddressAndBioRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript 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>