regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
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 TermRequest
            Public Overridable Property term As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class TermResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Integer
            Public Overridable Property description As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property registration_start_date As Nullable(Of Date)
            Public Overridable Property registration_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 add_start_date As Nullable(Of Date)
            Public Overridable Property add_end_date As Nullable(Of Date)
            Public Overridable Property grading_end_date As Nullable(Of Date)
            Public Overridable Property number_of_sections As Integer
            Public Overridable Property number_of_rates As Integer
        End Class
    End Namespace
End Namespace

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

{
	term: String
}
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
		}
	},
	term: String,
	reporting_term: String,
	reporting_year: 0,
	description: String,
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	registration_start_date: 0001-01-01,
	registration_end_date: 0001-01-01,
	drop_start_date: 0001-01-01,
	drop_end_date: 0001-01-01,
	add_start_date: 0001-01-01,
	add_end_date: 0001-01-01,
	grading_end_date: 0001-01-01,
	number_of_sections: 0,
	number_of_rates: 0
}