regis

SyncAddressRequest

**Requires Authentication**
Required permission:	SyncBioAndAddresses

The following routes are available for this service:
POST	/Sync/Address

"use strict";
export class SyncBioAndAddressResponse {
    /** @param {{responseStatus?:ResponseStatus,successfull?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    successfull;
}
export class SyncAddressRequest {
    /** @param {{regent_id?:number,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,email?:string,phone_home?:string,phone_bus?:string,phone_cell?:string,queued_by_username?:string,queued_by_CRM?:boolean,queued_by_RE?:boolean,queued_by_Sugar?:boolean,queued_by_REGIS?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    queued_by_username;
    /** @type {boolean} */
    queued_by_CRM;
    /** @type {boolean} */
    queued_by_RE;
    /** @type {boolean} */
    queued_by_Sugar;
    /** @type {boolean} */
    queued_by_REGIS;
}

JavaScript SyncAddressRequest 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 /Sync/Address HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SyncAddressRequest 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>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <email>String</email>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <queued_by_CRM>false</queued_by_CRM>
  <queued_by_RE>false</queued_by_RE>
  <queued_by_REGIS>false</queued_by_REGIS>
  <queued_by_Sugar>false</queued_by_Sugar>
  <queued_by_username>String</queued_by_username>
  <regent_id>0</regent_id>
  <state>String</state>
</SyncAddressRequest>

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

<SyncBioAndAddressResponse 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>
  <successfull>false</successfull>
</SyncBioAndAddressResponse>