regis

<back to all web services

SectionDocumentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/{uuid}/Documents
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class SectionDocumentsRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class DocumentResponse
    {
        public virtual string code { get; set; }
        public virtual string document_name { get; set; }
        public virtual string document_description { get; set; }
    }

    public partial class SectionDocumentsResponse
    {
        public SectionDocumentsResponse()
        {
            assigned_documents = new List<DocumentResponse>{};
            available_documents = new List<DocumentResponse>{};
        }

        public virtual string uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual List<DocumentResponse> assigned_documents { get; set; }
        public virtual List<DocumentResponse> available_documents { get; set; }
    }

}

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

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}