regis

AddressSyncRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/admissions/{uuid}/address/sync


export class AddressResponse
{
    public responseStatus: ResponseStatus;
    public addr1: string;
    public addr2: string;
    public country: string;
    public country_code: string;
    public state: string;
    public city: string;
    public code: string;
    public start_date?: string;
    public end_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

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

export class PhoneEmailResponse
{
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public start_date?: string;
    public end_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

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

export class AddressSyncResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public sugar_address: AddressResponse;
    public sugar_phone_email: PhoneEmailResponse;
    public regis_address: AddressResponse;
    public regis_phone_email: PhoneEmailResponse;
    public re_address: AddressResponse;
    public re_phone_email: PhoneEmailResponse;
    public exists_in_sugar: boolean;
    public exists_in_re: boolean;
    public are_equal: boolean;
    public addr_are_equal: boolean;
    public city_are_equal: boolean;
    public state_are_equal: boolean;
    public country_are_equal: boolean;
    public code_are_equal: boolean;
    public phone_home_are_equal: boolean;
    public phone_cell_are_equal: boolean;
    public phone_bus_are_equal: boolean;
    public email_are_equal: boolean;

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

export class AddressSyncRequest
{
    public uuid: string;

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

TypeScript AddressSyncRequest 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 /admissions/{uuid}/address/sync HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<AddressSyncResponse 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>
  <addr_are_equal>false</addr_are_equal>
  <are_equal>false</are_equal>
  <city_are_equal>false</city_are_equal>
  <code_are_equal>false</code_are_equal>
  <country_are_equal>false</country_are_equal>
  <email_are_equal>false</email_are_equal>
  <exists_in_re>false</exists_in_re>
  <exists_in_sugar>false</exists_in_sugar>
  <phone_bus_are_equal>false</phone_bus_are_equal>
  <phone_cell_are_equal>false</phone_cell_are_equal>
  <phone_home_are_equal>false</phone_home_are_equal>
  <re_address>
    <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>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <country_code>String</country_code>
    <end_date>0001-01-01T00:00:00</end_date>
    <start_date>0001-01-01T00:00:00</start_date>
    <state>String</state>
  </re_address>
  <re_phone_email>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <email>String</email>
    <end_date>0001-01-01T00:00:00</end_date>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <start_date>0001-01-01T00:00:00</start_date>
  </re_phone_email>
  <regent_id>0</regent_id>
  <regis_address>
    <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>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <country_code>String</country_code>
    <end_date>0001-01-01T00:00:00</end_date>
    <start_date>0001-01-01T00:00:00</start_date>
    <state>String</state>
  </regis_address>
  <regis_phone_email>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <email>String</email>
    <end_date>0001-01-01T00:00:00</end_date>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <start_date>0001-01-01T00:00:00</start_date>
  </regis_phone_email>
  <state_are_equal>false</state_are_equal>
  <sugar_address>
    <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>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <country_code>String</country_code>
    <end_date>0001-01-01T00:00:00</end_date>
    <start_date>0001-01-01T00:00:00</start_date>
    <state>String</state>
  </sugar_address>
  <sugar_phone_email>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <email>String</email>
    <end_date>0001-01-01T00:00:00</end_date>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <start_date>0001-01-01T00:00:00</start_date>
  </sugar_phone_email>
  <uuid>String</uuid>
</AddressSyncResponse>