regis

<back to all web services

SectionDocumentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/{uuid}/Documents
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SectionDocumentsRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public SectionDocumentsRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class SectionDocumentsResponse
    {
        public String uuid = null;
        public String course_name = null;
        public String title = null;
        public String term = null;
        public String reporting_term = null;
        public ArrayList<DocumentResponse> assigned_documents = null;
        public ArrayList<DocumentResponse> available_documents = null;
        
        public String getUuid() { return uuid; }
        public SectionDocumentsResponse setUuid(String value) { this.uuid = value; return this; }
        public String getCourseName() { return course_name; }
        public SectionDocumentsResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public SectionDocumentsResponse setTitle(String value) { this.title = value; return this; }
        public String getTerm() { return term; }
        public SectionDocumentsResponse setTerm(String value) { this.term = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public SectionDocumentsResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public ArrayList<DocumentResponse> getAssignedDocuments() { return assigned_documents; }
        public SectionDocumentsResponse setAssignedDocuments(ArrayList<DocumentResponse> value) { this.assigned_documents = value; return this; }
        public ArrayList<DocumentResponse> getAvailableDocuments() { return available_documents; }
        public SectionDocumentsResponse setAvailableDocuments(ArrayList<DocumentResponse> value) { this.available_documents = value; return this; }
    }

    public static class DocumentResponse
    {
        public String code = null;
        public String document_name = null;
        public String document_description = null;
        
        public String getCode() { return code; }
        public DocumentResponse setCode(String value) { this.code = value; return this; }
        public String getDocumentName() { return document_name; }
        public DocumentResponse setDocumentName(String value) { this.document_name = value; return this; }
        public String getDocumentDescription() { return document_description; }
        public DocumentResponse setDocumentDescription(String value) { this.document_description = value; return this; }
    }

}

Java 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>