regis

<back to all web services

SectionDocumentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/{uuid}/Documents
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val code:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set

    [<AllowNullLiteral>]
    type SectionDocumentsResponse() = 
        member val uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val title:String = null with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val assigned_documents:ResizeArray<DocumentResponse> = new ResizeArray<DocumentResponse>() with get,set
        member val available_documents:ResizeArray<DocumentResponse> = new ResizeArray<DocumentResponse>() with get,set

    [<AllowNullLiteral>]
    type SectionDocumentsRequest() = 
        member val uuid:String = null with get,set

F# 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"}]}