regis

<back to all web services

CourseRequirementsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}/Requirements
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 CourseRequirementsRequest
            Public Overridable Property id As Integer
        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

        Public Partial Class CourseRequirementsResponse
            Public Sub New()
                requirements = New List(Of CourseRequirementResponse)
                courses = New List(Of CourseResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property course_id As Integer
            Public Overridable Property requirements As List(Of CourseRequirementResponse)
            Public Overridable Property courses As List(Of CourseResponse)
        End Class

        Public Partial Class CourseResponse
            Public Overridable Property id As Nullable(Of Integer)
            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 added_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property timestamp As Date
        End Class
    End Namespace
End Namespace

VB.NET CourseRequirementsRequest 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 /Course/{id}/Requirements HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	course_id: 0,
	requirements: 
	[
		{
			course_id: 0,
			required_course_id: 0,
			requirement_group: 0,
			is_prerequisite: False,
			is_corequisite: False,
			timestamp: 0001-01-01
		}
	],
	courses: 
	[
		{
			id: 0,
			course_name: String,
			title: String,
			pretty_title: String,
			course_description: String,
			is_active: False,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	]
}