Required role: | REGISUserRole |
POST | /Sections/{uuid}/Documents |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses
Namespace Global
Namespace regis.ClassLibrary.Requests
Public Partial Class SectionDocumentsRequest
Public Overridable Property uuid As String
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class DocumentResponse
Public Overridable Property code As String
Public Overridable Property document_name As String
Public Overridable Property document_description As String
End Class
Public Partial Class SectionDocumentsResponse
Public Sub New()
assigned_documents = New List(Of DocumentResponse)
available_documents = New List(Of DocumentResponse)
End Sub
Public Overridable Property uuid As String
Public Overridable Property course_name As String
Public Overridable Property title As String
Public Overridable Property term As String
Public Overridable Property reporting_term As String
Public Overridable Property assigned_documents As List(Of DocumentResponse)
Public Overridable Property available_documents As List(Of DocumentResponse)
End Class
End Namespace
End Namespace
VB.NET SectionDocumentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>