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.*


open class SectionDocumentsRequest
{
    var uuid:String? = null
}

open class SectionDocumentsResponse
{
    var uuid:String? = null
    var course_name:String? = null
    var title:String? = null
    var term:String? = null
    var reporting_term:String? = null
    var assigned_documents:ArrayList<DocumentResponse> = ArrayList<DocumentResponse>()
    var available_documents:ArrayList<DocumentResponse> = ArrayList<DocumentResponse>()
}

open class DocumentResponse
{
    var code:String? = null
    var document_name:String? = null
    var document_description:String? = null
}

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