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

export class PhoneEmailResponse
{
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public email: string;
    public start_date?: string;
    public end_date?: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

    public constructor(init?: Partial<PhoneEmailResponse>) { (Object as any).assign(this, init); }
}

export class PhoneEmailHistoryResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public phoneEmails: PhoneEmailResponse[];

    public constructor(init?: Partial<PhoneEmailHistoryResponse>) { (Object as any).assign(this, init); }
}

export class PhoneEmailHistoryRequest
{
    public uuid: string;

    public constructor(init?: Partial<PhoneEmailHistoryRequest>) { (Object as any).assign(this, init); }
}

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