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

<SectionDocumentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</SectionDocumentsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SectionDocumentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <assigned_documents>
    <DocumentResponse>
      <code>String</code>
      <document_description>String</document_description>
      <document_name>String</document_name>
    </DocumentResponse>
  </assigned_documents>
  <available_documents>
    <DocumentResponse>
      <code>String</code>
      <document_description>String</document_description>
      <document_name>String</document_name>
    </DocumentResponse>
  </available_documents>
  <course_name>String</course_name>
  <reporting_term>String</reporting_term>
  <term>String</term>
  <title>String</title>
  <uuid>String</uuid>
</SectionDocumentsResponse>