regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SyncBioRequest
    {
        public Integer regent_id = null;
        public String first_name = null;
        public String last_name = null;
        public String middle_name = null;
        public String preferred_name = null;
        public String birth_name = null;
        public String prefix = null;
        public String current_occupation = null;
        public Date dob = null;
        public Date deceased_date = null;
        public String gender = null;
        public String marital_status = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public String queued_by_username = null;
        public Boolean queued_by_CRM = null;
        public Boolean queued_by_RE = null;
        public Boolean queued_by_REGIS = null;
        public Boolean queued_by_Sugar = null;
        
        public Integer getRegentId() { return regent_id; }
        public SyncBioRequest setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFirstName() { return first_name; }
        public SyncBioRequest setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public SyncBioRequest setLastName(String value) { this.last_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public SyncBioRequest setMiddleName(String value) { this.middle_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public SyncBioRequest setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getBirthName() { return birth_name; }
        public SyncBioRequest setBirthName(String value) { this.birth_name = value; return this; }
        public String getPrefix() { return prefix; }
        public SyncBioRequest setPrefix(String value) { this.prefix = value; return this; }
        public String getCurrentOccupation() { return current_occupation; }
        public SyncBioRequest setCurrentOccupation(String value) { this.current_occupation = value; return this; }
        public Date getDob() { return dob; }
        public SyncBioRequest setDob(Date value) { this.dob = value; return this; }
        public Date getDeceasedDate() { return deceased_date; }
        public SyncBioRequest setDeceasedDate(Date value) { this.deceased_date = value; return this; }
        public String getGender() { return gender; }
        public SyncBioRequest setGender(String value) { this.gender = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public SyncBioRequest setMaritalStatus(String value) { this.marital_status = value; return this; }
        public String getCitizenship() { return citizenship; }
        public SyncBioRequest setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public SyncBioRequest setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public SyncBioRequest setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public String getQueuedByUsername() { return queued_by_username; }
        public SyncBioRequest setQueuedByUsername(String value) { this.queued_by_username = value; return this; }
        public Boolean isQueuedByCrm() { return queued_by_CRM; }
        public SyncBioRequest setQueuedByCrm(Boolean value) { this.queued_by_CRM = value; return this; }
        public Boolean isQueuedByRe() { return queued_by_RE; }
        public SyncBioRequest setQueuedByRe(Boolean value) { this.queued_by_RE = value; return this; }
        public Boolean isQueuedByRegis() { return queued_by_REGIS; }
        public SyncBioRequest setQueuedByRegis(Boolean value) { this.queued_by_REGIS = value; return this; }
        public Boolean isQueuedBySugar() { return queued_by_Sugar; }
        public SyncBioRequest setQueuedBySugar(Boolean value) { this.queued_by_Sugar = value; return this; }
    }

    public static class SyncBioAndAddressResponse
    {
        public ResponseStatus responseStatus = null;
        public Boolean successfull = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SyncBioAndAddressResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Boolean isSuccessfull() { return successfull; }
        public SyncBioAndAddressResponse setSuccessfull(Boolean value) { this.successfull = value; return this; }
    }

}

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

<SyncBioRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <birth_name>String</birth_name>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <current_occupation>String</current_occupation>
  <deceased_date>0001-01-01T00:00:00</deceased_date>
  <dob>0001-01-01T00:00:00</dob>
  <first_name>String</first_name>
  <gender>String</gender>
  <last_name>String</last_name>
  <marital_status>String</marital_status>
  <middle_name>String</middle_name>
  <permanent_resident>String</permanent_resident>
  <preferred_name>String</preferred_name>
  <prefix>String</prefix>
  <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>
</SyncBioRequest>
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>