Required role: | REGISUserRole |
POST | /Sections/Admin/{reporting_term}/Create |
---|
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 SectionCreateRequest
Public Overridable Property course_id As Nullable(Of Integer)
Public Overridable Property course_name As String
Public Overridable Property min_credits As Nullable(Of Decimal)
Public Overridable Property max_credits As Nullable(Of Decimal)
Public Overridable Property credit_increments As Nullable(Of Decimal)
Public Overridable Property min_audits As Nullable(Of Decimal)
Public Overridable Property max_audits As Nullable(Of Decimal)
Public Overridable Property audit_increments As Nullable(Of Decimal)
Public Overridable Property section_code As String
Public Overridable Property title As String
Public Overridable Property pretty_title As String
Public Overridable Property override_course_description As String
Public Overridable Property current_status As String
Public Overridable Property location As String
Public Overridable Property room As String
Public Overridable Property is_audio As Boolean
Public Overridable Property is_oncampus As Boolean
Public Overridable Property distance_ed_materials As String
Public Overridable Property start_date As Nullable(Of Date)
Public Overridable Property end_date As Nullable(Of Date)
Public Overridable Property first_meeting_date As Nullable(Of Date)
Public Overridable Property last_meeting_date As Nullable(Of Date)
Public Overridable Property start_times As String
Public Overridable Property end_times As String
Public Overridable Property meeting_days As String
Public Overridable Property is_pass_fail As Boolean
Public Overridable Property is_waitlist As Boolean
Public Overridable Property has_special_requirements As Boolean
Public Overridable Property special_requirements As String
Public Overridable Property is_unlisted As Boolean
Public Overridable Property capacity As Nullable(Of Integer)
Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
Public Overridable Property override_registration_start_date As Nullable(Of Date)
Public Overridable Property override_registration_end_date As Nullable(Of Date)
Public Overridable Property override_add_start_date As Nullable(Of Date)
Public Overridable Property override_add_end_date As Nullable(Of Date)
Public Overridable Property override_drop_start_date As Nullable(Of Date)
Public Overridable Property override_drop_end_date As Nullable(Of Date)
Public Overridable Property override_grading_end_date As Nullable(Of Date)
Public Overridable Property term As String
Public Overridable Property reporting_term As String
Public Overridable Property authorizing_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 InstructorResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property regent_id As Integer
Public Overridable Property regent_login As String
Public Overridable Property preferred_name As String
Public Overridable Property first_name As String
Public Overridable Property last_name As String
Public Overridable Property full_name As String
Public Overridable Property email As String
Public Overridable Property image_base64 As String
End Class
Public Partial Class SectionResponse
Public Sub New()
instructors = New List(Of InstructorResponse)
required_documents = New List(Of DocumentResponse)
start_times = New List(Of String)
end_times = New List(Of String)
credit_amounts = New List(Of Decimal)
audit_amounts = New List(Of Decimal)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property secUUID As String
Public Overridable Property course_name As String
Public Overridable Property section_code As String
Public Overridable Property course_title As String
Public Overridable Property course_short_title As String
Public Overridable Property course_description As String
Public Overridable Property crosslist_description As String
Public Overridable Property crosslist_course_name As String
Public Overridable Property location_long_name As String
Public Overridable Property room As String
Public Overridable Property instructors As List(Of InstructorResponse)
Public Overridable Property required_documents As List(Of DocumentResponse)
Public Overridable Property start_date As Nullable(Of Date)
Public Overridable Property end_date As Nullable(Of Date)
Public Overridable Property first_meeting_date As Nullable(Of Date)
Public Overridable Property last_meeting_date As Nullable(Of Date)
Public Overridable Property meeting_days As String
Public Overridable Property start_times As List(Of String)
Public Overridable Property end_times As List(Of String)
Public Overridable Property is_online_only As Boolean
Public Overridable Property is_weekend As Boolean
Public Overridable Property is_weekday As Boolean
Public Overridable Property is_evening As Boolean
Public Overridable Property is_waitlist As Boolean
Public Overridable Property has_special_requirements As Boolean
Public Overridable Property special_requirements As String
Public Overridable Property is_unlisted As Boolean
Public Overridable Property credit_amounts As List(Of Decimal)
Public Overridable Property audit_amounts As List(Of Decimal)
Public Overridable Property audits_short_name As String
Public Overridable Property audits_long_name As String
Public Overridable Property credits_short_name As String
Public Overridable Property credits_long_name As String
Public Overridable Property distance_ed_materials As String
Public Overridable Property prerequisites As String
Public Overridable Property corequisites As String
Public Overridable Property capacity As Nullable(Of Integer)
Public Overridable Property flat_fee_amount As Nullable(Of Decimal)
Public Overridable Property additional_fee_amount As Nullable(Of Decimal)
Public Overridable Property registered_students As Integer
Public Overridable Property three_credit_plus As Integer
Public Overridable Property two_credit As Integer
Public Overridable Property one_credit As Integer
Public Overridable Property three_audit_plus As Integer
Public Overridable Property two_audit As Integer
Public Overridable Property one_audit As Integer
Public Overridable Property crosslist_registered_students As Integer
Public Overridable Property grades_received As Integer
Public Overridable Property crosslist_grades_received As Integer
Public Overridable Property registration_start_date As Nullable(Of Date)
Public Overridable Property registration_end_date As Nullable(Of Date)
Public Overridable Property add_start_date As Nullable(Of Date)
Public Overridable Property add_end_date As Nullable(Of Date)
Public Overridable Property drop_start_date As Nullable(Of Date)
Public Overridable Property drop_end_date As Nullable(Of Date)
Public Overridable Property grading_end_date As Nullable(Of Date)
Public Overridable Property term As String
Public Overridable Property reporting_term As String
Public Overridable Property reporting_year As Integer
Public Overridable Property current_status As String
Public Overridable Property added_by As String
Public Overridable Property added_date As Nullable(Of Date)
Public Overridable Property changed_by As String
Public Overridable Property changed_date As Nullable(Of Date)
Public Overridable Property timestamp As Date
End Class
End Namespace
End Namespace
VB.NET SectionCreateRequest 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/Admin/{reporting_term}/Create HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SectionCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<additional_fee_amount>0</additional_fee_amount>
<audit_increments>0</audit_increments>
<authorizing_uuid>String</authorizing_uuid>
<capacity>0</capacity>
<course_id>0</course_id>
<course_name>String</course_name>
<credit_increments>0</credit_increments>
<current_status>String</current_status>
<distance_ed_materials>String</distance_ed_materials>
<end_date>0001-01-01T00:00:00</end_date>
<end_times>String</end_times>
<first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
<flat_fee_amount>0</flat_fee_amount>
<has_special_requirements>false</has_special_requirements>
<is_audio>false</is_audio>
<is_oncampus>false</is_oncampus>
<is_pass_fail>false</is_pass_fail>
<is_unlisted>false</is_unlisted>
<is_waitlist>false</is_waitlist>
<last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
<location>String</location>
<max_audits>0</max_audits>
<max_credits>0</max_credits>
<meeting_days>String</meeting_days>
<min_audits>0</min_audits>
<min_credits>0</min_credits>
<override_add_end_date>0001-01-01T00:00:00</override_add_end_date>
<override_add_start_date>0001-01-01T00:00:00</override_add_start_date>
<override_course_description>String</override_course_description>
<override_drop_end_date>0001-01-01T00:00:00</override_drop_end_date>
<override_drop_start_date>0001-01-01T00:00:00</override_drop_start_date>
<override_grading_end_date>0001-01-01T00:00:00</override_grading_end_date>
<override_registration_end_date>0001-01-01T00:00:00</override_registration_end_date>
<override_registration_start_date>0001-01-01T00:00:00</override_registration_start_date>
<pretty_title>String</pretty_title>
<reporting_term>String</reporting_term>
<room>String</room>
<section_code>String</section_code>
<special_requirements>String</special_requirements>
<start_date>0001-01-01T00:00:00</start_date>
<start_times>String</start_times>
<term>String</term>
<title>String</title>
</SectionCreateRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <add_end_date>0001-01-01T00:00:00</add_end_date> <add_start_date>0001-01-01T00:00:00</add_start_date> <added_by>String</added_by> <added_date>0001-01-01T00:00:00</added_date> <additional_fee_amount>0</additional_fee_amount> <audit_amounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:decimal>0</d2p1:decimal> </audit_amounts> <audits_long_name>String</audits_long_name> <audits_short_name>String</audits_short_name> <capacity>0</capacity> <changed_by>String</changed_by> <changed_date>0001-01-01T00:00:00</changed_date> <corequisites>String</corequisites> <course_description>String</course_description> <course_name>String</course_name> <course_short_title>String</course_short_title> <course_title>String</course_title> <credit_amounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:decimal>0</d2p1:decimal> </credit_amounts> <credits_long_name>String</credits_long_name> <credits_short_name>String</credits_short_name> <crosslist_course_name>String</crosslist_course_name> <crosslist_description>String</crosslist_description> <crosslist_grades_received>0</crosslist_grades_received> <crosslist_registered_students>0</crosslist_registered_students> <current_status>String</current_status> <distance_ed_materials>String</distance_ed_materials> <drop_end_date>0001-01-01T00:00:00</drop_end_date> <drop_start_date>0001-01-01T00:00:00</drop_start_date> <end_date>0001-01-01T00:00:00</end_date> <end_times xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </end_times> <first_meeting_date>0001-01-01T00:00:00</first_meeting_date> <flat_fee_amount>0</flat_fee_amount> <grades_received>0</grades_received> <grading_end_date>0001-01-01T00:00:00</grading_end_date> <has_special_requirements>false</has_special_requirements> <instructors> <InstructorResponse> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> <email>String</email> <first_name>String</first_name> <full_name>String</full_name> <image_base64>String</image_base64> <last_name>String</last_name> <preferred_name>String</preferred_name> <regent_id>0</regent_id> <regent_login>String</regent_login> </InstructorResponse> </instructors> <is_evening>false</is_evening> <is_online_only>false</is_online_only> <is_unlisted>false</is_unlisted> <is_waitlist>false</is_waitlist> <is_weekday>false</is_weekday> <is_weekend>false</is_weekend> <last_meeting_date>0001-01-01T00:00:00</last_meeting_date> <location_long_name>String</location_long_name> <meeting_days>String</meeting_days> <one_audit>0</one_audit> <one_credit>0</one_credit> <prerequisites>String</prerequisites> <registered_students>0</registered_students> <registration_end_date>0001-01-01T00:00:00</registration_end_date> <registration_start_date>0001-01-01T00:00:00</registration_start_date> <reporting_term>String</reporting_term> <reporting_year>0</reporting_year> <required_documents> <DocumentResponse> <code>String</code> <document_description>String</document_description> <document_name>String</document_name> </DocumentResponse> </required_documents> <room>String</room> <secUUID>String</secUUID> <section_code>String</section_code> <special_requirements>String</special_requirements> <start_date>0001-01-01T00:00:00</start_date> <start_times xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </start_times> <term>String</term> <three_audit_plus>0</three_audit_plus> <three_credit_plus>0</three_credit_plus> <timestamp>0001-01-01T00:00:00</timestamp> <two_audit>0</two_audit> <two_credit>0</two_credit> </SectionResponse>