regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
import Foundation
import ServiceStack

public class TermRequest : Codable
{
    public var term:String

    required public init(){}
}

public class TermResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var term:String
    public var reporting_term:String
    public var reporting_year:Int
    public var Description:String
    public var start_date:Date?
    public var end_date:Date?
    public var registration_start_date:Date?
    public var registration_end_date:Date?
    public var drop_start_date:Date?
    public var drop_end_date:Date?
    public var add_start_date:Date?
    public var add_end_date:Date?
    public var grading_end_date:Date?
    public var number_of_sections:Int
    public var number_of_rates:Int

    required public init(){}
}


Swift 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
}