regis

<back to all web services

PhoneEmailHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/phoneemail/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 PhoneEmailResponse() = 
        member val phone_home:String = null with get,set
        member val phone_cell:String = null with get,set
        member val phone_bus:String = null with get,set
        member val email:String = null with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_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 PhoneEmailHistoryResponse() = 
        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 phoneEmails:ResizeArray<PhoneEmailResponse> = new ResizeArray<PhoneEmailResponse>() with get,set

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

F# PhoneEmailHistoryRequest 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}/phoneemail/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,
	phoneEmails: 
	[
		{
			phone_home: String,
			phone_cell: String,
			phone_bus: String,
			email: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			added_by: String,
			added_date: 0001-01-01,
			changed_by: String,
			changed_date: 0001-01-01
		}
	]
}