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
import Foundation
import ServiceStack

public class PhoneEmailHistoryRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class PhoneEmailHistoryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid:String
    public var regent_id:Int
    public var phoneEmails:[PhoneEmailResponse] = []

    required public init(){}
}

public class PhoneEmailResponse : Codable
{
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var email:String
    public var start_date:Date?
    public var end_date:Date?
    public var added_by:String
    public var added_date:Date?
    public var changed_by:String
    public var changed_date:Date?

    required public init(){}
}


Swift 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
		}
	]
}