regis

PersonKeysRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/keys/all

"use strict";
export class PersonKeyResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,re_id?:number,sugar_id?:string,uuid?:string,student_id?:number,regent_login?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {number} */
    re_id;
    /** @type {string} */
    sugar_id;
    /** @type {string} */
    uuid;
    /** @type {?number} */
    student_id;
    /** @type {string} */
    regent_login;
}
export class PersonKeysResponse {
    /** @param {{responseStatus?:ResponseStatus,personKeyResponses?:PersonKeyResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {PersonKeyResponse[]} */
    personKeyResponses;
}
export class PersonKeysRequest {
    constructor(init) { Object.assign(this, init) }
}

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

{
	
}

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
		}
	},
	personKeyResponses: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			re_id: 0,
			sugar_id: String,
			uuid: String,
			student_id: 0,
			regent_login: String
		}
	]
}