regis

<back to all web services

CanIRegisterRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/CanIRegister/{uuid}/Term/{reporting_term}
"use strict";
export class CanIRegisterResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,reporting_term?:string,maxCredits?:number,maxAudits?:number,messages?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    maxCredits;
    /** @type {number} */
    maxAudits;
    /** @type {string[]} */
    messages;
}
export class CanIRegisterRequest {
    /** @param {{uuid?:string,term?:string,reporting_term?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
}

JavaScript CanIRegisterRequest 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 /Registration/CanIRegister/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	term: String,
	reporting_term: 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
		}
	},
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	maxCredits: 0,
	maxAudits: 0,
	messages: 
	[
		String
	]
}