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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class BioHistoryRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class BioHistoryResponse
    {
        public BioHistoryResponse()
        {
            bios = new List<BioResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual List<BioResponse> bios { get; set; }
    }

    public partial class BioResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string first_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string birth_name { get; set; }
        public virtual string prefix { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_code { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual string citizenship_other_code { get; set; }
        public virtual string permanent_resident_code { get; set; }
        public virtual string gender { get; set; }
        public virtual string gender_code { get; set; }
        public virtual string marital_status { get; set; }
        public virtual string marital_status_code { get; set; }
        public virtual DateTime? deceased_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

}

C# BioHistoryRequest DTOs

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

HTTP + JSV

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

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			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-01,
			added_by: String,
			added_date: 0001-01-01,
			changed_by: String,
			changed_date: 0001-01-01
		}
	]
}