regis

<back to all web services

BioHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/history
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type BioResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val first_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val last_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 dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val citizenship:String = null with get,set
        member val citizenship_code: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 citizenship_other_code:String = null with get,set
        member val permanent_resident_code:String = null with get,set
        member val gender:String = null with get,set
        member val gender_code:String = null with get,set
        member val marital_status:String = null with get,set
        member val marital_status_code:String = null with get,set
        member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type BioHistoryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val bios:ResizeArray<BioResponse> = new ResizeArray<BioResponse>() with get,set

    [<AllowNullLiteral>]
    type BioHistoryRequest() = 
        member val uuid:String = null with get,set

F# BioHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admissions/{uuid}/bio/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"bios":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","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":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}