regis

<back to all web services

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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"regent_id":0,"first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","current_occupation":"String","dob":"0001-01-01T00:00:00.0000000","deceased_date":"0001-01-01T00:00:00.0000000","gender":"String","marital_status":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","queued_by_username":"String","queued_by_CRM":false,"queued_by_RE":false,"queued_by_REGIS":false,"queued_by_Sugar":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"successfull":false}