regis

<back to all web services

CourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}
"use strict";
export class CourseResponse {
    /** @param {{id?:number,course_name?:string,title?:string,pretty_title?:string,course_description?:string,is_active?:boolean,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string,timestamp?: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 {?string} */
    added_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    changed_by;
    /** @type {string} */
    timestamp;
}
export class CourseRequest {
    /** @param {{id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
}

JavaScript CourseRequest DTOs

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

HTTP + XML

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

POST /Course/{id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <id>0</id>
</CourseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <id>0</id>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <timestamp>0001-01-01T00:00:00</timestamp>
  <title>String</title>
</CourseResponse>