regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
TermRequest Parameters:
NameParameterData TypeRequiredDescription
termpathstringNo
TermResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
termformstringNo
reporting_termformstringNo
reporting_yearformintNo
descriptionformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
registration_start_dateformDateTime?No
registration_end_dateformDateTime?No
drop_start_dateformDateTime?No
drop_end_dateformDateTime?No
add_start_dateformDateTime?No
add_end_dateformDateTime?No
grading_end_dateformDateTime?No
number_of_sectionsformintNo
number_of_ratesformintNo

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
}