regis

<back to all web services

AddressAndBioUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressandbio/update

export class AddressAndBioUpdateResponse
{
    public responseStatus: ResponseStatus;
    public update_success: boolean;
    public messages: string[];

    public constructor(init?: Partial<AddressAndBioUpdateResponse>) { (Object as any).assign(this, init); }
}

export class AddressAndBioUpdateRequest
{
    public uuid: string;
    public spouse_regent_id?: number;
    public first_name: string;
    public middle_name: string;
    public last_name: string;
    public preferred_name: string;
    public birth_name: string;
    public addr1: string;
    public addr2: string;
    public country: string;
    public state: string;
    public city: string;
    public code: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public prefix: string;
    public dob?: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public denomination: string;
    public occupation: string;
    public ethnicity: string;
    public gender: string;
    public marital_status: string;
    public deceased_date?: string;
    public tax_number: string;
    public update_re_and_sugar: boolean;
    public regent_title: string;
    public regent_department: string;
    public regent_faculty_profile_url: string;
    public regent_image_url: string;
    public include_on_website: boolean;
    public authorizing_uuid: string;

    public constructor(init?: Partial<AddressAndBioUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript AddressAndBioUpdateRequest 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/update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddressAndBioUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <addr1>String</addr1>
  <addr2>String</addr2>
  <authorizing_uuid>String</authorizing_uuid>
  <birth_name>String</birth_name>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <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>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <occupation>String</occupation>
  <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_department>String</regent_department>
  <regent_faculty_profile_url>String</regent_faculty_profile_url>
  <regent_image_url>String</regent_image_url>
  <regent_title>String</regent_title>
  <spouse_regent_id>0</spouse_regent_id>
  <state>String</state>
  <tax_number>String</tax_number>
  <update_re_and_sugar>false</update_re_and_sugar>
  <uuid>String</uuid>
</AddressAndBioUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddressAndBioUpdateResponse 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>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <update_success>false</update_success>
</AddressAndBioUpdateResponse>