regis

SyncBioRequest

**Requires Authentication**
Required permission:	SyncBioAndAddresses

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

namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SyncBioAndAddressResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val successfull:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SyncBioRequest() = 
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val preferred_name:String = null with get,set
        member val birth_name:String = null with get,set
        member val prefix:String = null with get,set
        member val current_occupation:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val gender:String = null with get,set
        member val marital_status:String = null with get,set
        member val citizenship:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val queued_by_username:String = null with get,set
        member val queued_by_CRM:Boolean = new Boolean() with get,set
        member val queued_by_RE:Boolean = new Boolean() with get,set
        member val queued_by_REGIS:Boolean = new Boolean() with get,set
        member val queued_by_Sugar:Boolean = new Boolean() with get,set

F# 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>