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 Foundation
import ServiceStack

public class SectionDocumentsRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class SectionDocumentsResponse : Codable
{
    public var uuid:String
    public var course_name:String
    public var title:String
    public var term:String
    public var reporting_term:String
    public var assigned_documents:[DocumentResponse] = []
    public var available_documents:[DocumentResponse] = []

    required public init(){}
}

public class DocumentResponse : Codable
{
    public var code:String
    public var document_name:String
    public var document_description:String

    required public init(){}
}


Swift 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
		}
	]
}