regis

<back to all web services

CourseUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/Update/{id}
"use strict";
export class CourseRequirementResponse {
    /** @param {{course_id?:number,required_course_id?:number,requirement_group?:number,is_prerequisite?:boolean,is_corequisite?:boolean,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    course_id;
    /** @type {number} */
    required_course_id;
    /** @type {number} */
    requirement_group;
    /** @type {boolean} */
    is_prerequisite;
    /** @type {boolean} */
    is_corequisite;
    /** @type {string} */
    timestamp;
}
export class CourseUpdateRequest {
    /** @param {{id?:number,course_name?:string,title?:string,pretty_title?:string,course_description?:string,is_active?:boolean,course_requirements?:CourseRequirementResponse[],authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    pretty_title;
    /** @type {string} */
    course_description;
    /** @type {boolean} */
    is_active;
    /** @type {CourseRequirementResponse[]} */
    course_requirements;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript CourseUpdateRequest 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 /Courses/Admin/Update/{id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	course_name: String,
	title: String,
	pretty_title: String,
	course_description: String,
	is_active: False,
	course_requirements: 
	[
		{
			course_id: 0,
			required_course_id: 0,
			requirement_group: 0,
			is_prerequisite: False,
			is_corequisite: False,
			timestamp: 0001-01-01
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}