regis

<back to all web services

StudentAcademicCredentialAdditionalInstructorsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentAcademicCredential/{uuid}/AdditionalInstructors/{stac_uuid}
"use strict";
export class InstructorResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,regent_login?:string,preferred_name?:string,first_name?:string,last_name?:string,full_name?:string,email?:string,image_base64?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    full_name;
    /** @type {string} */
    email;
    /** @type {string} */
    image_base64;
}
export class StudentAcademicCredentialAdditionalInstructorsResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,stac_uuid?:string,course_name?:string,term?:string,reporting_term?:string,instructors?:InstructorResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {string} */
    stac_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {InstructorResponse[]} */
    instructors;
}
export class StudentAcademicCredentialAdditionalInstructorsRequest {
    /** @param {{uuid?:string,stac_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    stac_uuid;
}

JavaScript StudentAcademicCredentialAdditionalInstructorsRequest 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 /StudentAcademicCredential/{uuid}/AdditionalInstructors/{stac_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	stac_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,
	stac_uuid: String,
	course_name: String,
	term: String,
	reporting_term: String,
	instructors: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			regent_login: String,
			preferred_name: String,
			first_name: String,
			last_name: String,
			full_name: String,
			email: String,
			image_base64: String
		}
	]
}