regis

BioSyncRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class BioResponse {
    /** @param {{responseStatus?:ResponseStatus,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_name?:string,prefix?:string,dob?:string,citizenship?:string,citizenship_code?:string,citizenship_other?:string,permanent_resident?:string,citizenship_other_code?:string,permanent_resident_code?:string,gender?:string,gender_code?:string,marital_status?:string,marital_status_code?:string,deceased_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_code;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    citizenship_other_code;
    /** @type {string} */
    permanent_resident_code;
    /** @type {string} */
    gender;
    /** @type {string} */
    gender_code;
    /** @type {string} */
    marital_status;
    /** @type {string} */
    marital_status_code;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class BioSyncResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,sugar_bio?:BioResponse,regis_bio?:BioResponse,re_bio?:BioResponse,exists_in_sugar?:boolean,exists_in_re?:boolean,are_equal?:boolean,first_name_are_equal?:boolean,middle_name_are_equal?:boolean,last_name_are_equal?:boolean,preferred_name_are_equal?:boolean,birth_name_are_equal?:boolean,prefix_are_equal?:boolean,dob_are_equal?:boolean,deceased_are_equal?:boolean,citizenship_are_equal?:boolean,gender_are_equal?:boolean,marital_status_are_equal?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {BioResponse} */
    sugar_bio;
    /** @type {BioResponse} */
    regis_bio;
    /** @type {BioResponse} */
    re_bio;
    /** @type {boolean} */
    exists_in_sugar;
    /** @type {boolean} */
    exists_in_re;
    /** @type {boolean} */
    are_equal;
    /** @type {boolean} */
    first_name_are_equal;
    /** @type {boolean} */
    middle_name_are_equal;
    /** @type {boolean} */
    last_name_are_equal;
    /** @type {boolean} */
    preferred_name_are_equal;
    /** @type {boolean} */
    birth_name_are_equal;
    /** @type {boolean} */
    prefix_are_equal;
    /** @type {boolean} */
    dob_are_equal;
    /** @type {boolean} */
    deceased_are_equal;
    /** @type {boolean} */
    citizenship_are_equal;
    /** @type {boolean} */
    gender_are_equal;
    /** @type {boolean} */
    marital_status_are_equal;
}
export class BioSyncRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript BioSyncRequest 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}/bio/sync HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<BioSyncResponse 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>
  <are_equal>false</are_equal>
  <birth_name_are_equal>false</birth_name_are_equal>
  <citizenship_are_equal>false</citizenship_are_equal>
  <deceased_are_equal>false</deceased_are_equal>
  <dob_are_equal>false</dob_are_equal>
  <exists_in_re>false</exists_in_re>
  <exists_in_sugar>false</exists_in_sugar>
  <first_name_are_equal>false</first_name_are_equal>
  <gender_are_equal>false</gender_are_equal>
  <last_name_are_equal>false</last_name_are_equal>
  <marital_status_are_equal>false</marital_status_are_equal>
  <middle_name_are_equal>false</middle_name_are_equal>
  <preferred_name_are_equal>false</preferred_name_are_equal>
  <prefix_are_equal>false</prefix_are_equal>
  <re_bio>
    <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>
    <birth_name>String</birth_name>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <citizenship>String</citizenship>
    <citizenship_code>String</citizenship_code>
    <citizenship_other>String</citizenship_other>
    <citizenship_other_code>String</citizenship_other_code>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <dob>0001-01-01T00:00:00</dob>
    <first_name>String</first_name>
    <gender>String</gender>
    <gender_code>String</gender_code>
    <last_name>String</last_name>
    <marital_status>String</marital_status>
    <marital_status_code>String</marital_status_code>
    <middle_name>String</middle_name>
    <permanent_resident>String</permanent_resident>
    <permanent_resident_code>String</permanent_resident_code>
    <preferred_name>String</preferred_name>
    <prefix>String</prefix>
  </re_bio>
  <regent_id>0</regent_id>
  <regis_bio>
    <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>
    <birth_name>String</birth_name>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <citizenship>String</citizenship>
    <citizenship_code>String</citizenship_code>
    <citizenship_other>String</citizenship_other>
    <citizenship_other_code>String</citizenship_other_code>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <dob>0001-01-01T00:00:00</dob>
    <first_name>String</first_name>
    <gender>String</gender>
    <gender_code>String</gender_code>
    <last_name>String</last_name>
    <marital_status>String</marital_status>
    <marital_status_code>String</marital_status_code>
    <middle_name>String</middle_name>
    <permanent_resident>String</permanent_resident>
    <permanent_resident_code>String</permanent_resident_code>
    <preferred_name>String</preferred_name>
    <prefix>String</prefix>
  </regis_bio>
  <sugar_bio>
    <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>
    <birth_name>String</birth_name>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <citizenship>String</citizenship>
    <citizenship_code>String</citizenship_code>
    <citizenship_other>String</citizenship_other>
    <citizenship_other_code>String</citizenship_other_code>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <dob>0001-01-01T00:00:00</dob>
    <first_name>String</first_name>
    <gender>String</gender>
    <gender_code>String</gender_code>
    <last_name>String</last_name>
    <marital_status>String</marital_status>
    <marital_status_code>String</marital_status_code>
    <middle_name>String</middle_name>
    <permanent_resident>String</permanent_resident>
    <permanent_resident_code>String</permanent_resident_code>
    <preferred_name>String</preferred_name>
    <prefix>String</prefix>
  </sugar_bio>
  <uuid>String</uuid>
</BioSyncResponse>