regis

<back to all web services

CourseCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/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 CourseCreateRequest
            Public Sub New()
                course_requirements = New List(Of CourseRequirementResponse)
            End Sub

            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property pretty_title As String
            Public Overridable Property course_description As String
            Public Overridable Property is_active As Boolean
            Public Overridable Property course_requirements As List(Of CourseRequirementResponse)
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class CourseRequirementResponse
            Public Overridable Property course_id As Integer
            Public Overridable Property required_course_id As Integer
            Public Overridable Property requirement_group As Integer
            Public Overridable Property is_prerequisite As Boolean
            Public Overridable Property is_corequisite As Boolean
            Public Overridable Property timestamp As Date
        End Class
    End Namespace
End Namespace

VB.NET CourseCreateRequest 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 /Courses/Admin/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	course_name: String,
	title: String,
	pretty_title: String,
	course_description: String,
	is_active: False,
	course_requirements: 
	[
		{
			course_id: 0,
			required_course_id: 0,
			requirement_group: 0,
			is_prerequisite: False,
			is_corequisite: False,
			timestamp: 0001-01-01
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}