regis

<back to all web services

CourseCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/Create
"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 CourseCreateRequest {
    /** @param {{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 {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 CourseCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Courses/Admin/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"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-01T00:00:00.0000000"}],"authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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