regis

<back to all web services

AuditRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Audit
"use strict";
export class AuditResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,ip_address?:string,url?:string,controller?:string,action?:string,item_id?:string,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {string} */
    ip_address;
    /** @type {string} */
    url;
    /** @type {string} */
    controller;
    /** @type {string} */
    action;
    /** @type {string} */
    item_id;
    /** @type {string} */
    timestamp;
}
export class AuditsResponse {
    /** @param {{responseStatus?:ResponseStatus,audits?:AuditResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {AuditResponse[]} */
    audits;
}
export class AuditRequest {
    /** @param {{uuid?:string,created_since_date?:string,controller?:string,action?:string,item_id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    created_since_date;
    /** @type {string} */
    controller;
    /** @type {string} */
    action;
    /** @type {string} */
    item_id;
}

JavaScript AuditRequest 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 /Audit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	created_since_date: 0001-01-01,
	controller: String,
	action: String,
	item_id: 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
		}
	},
	audits: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			uuid: String,
			ip_address: String,
			url: String,
			controller: String,
			action: String,
			item_id: String,
			timestamp: 0001-01-01
		}
	]
}