regis

SectionDocumentsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Sections/{uuid}/Documents

"use strict";
export class DocumentResponse {
    /** @param {{code?:string,document_name?:string,document_description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    code;
    /** @type {string} */
    document_name;
    /** @type {string} */
    document_description;
}
export class SectionDocumentsResponse {
    /** @param {{uuid?:string,course_name?:string,title?:string,term?:string,reporting_term?:string,assigned_documents?:DocumentResponse[],available_documents?:DocumentResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {DocumentResponse[]} */
    assigned_documents;
    /** @type {DocumentResponse[]} */
    available_documents;
}
export class SectionDocumentsRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

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

{
	uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	course_name: String,
	title: String,
	term: String,
	reporting_term: String,
	assigned_documents: 
	[
		{
			code: String,
			document_name: String,
			document_description: String
		}
	],
	available_documents: 
	[
		{
			code: String,
			document_name: String,
			document_description: String
		}
	]
}