regis

<back to all web services

TermCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Terms/Create
TermCreateRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
termbodystringNo
reporting_termbodystringNo
reporting_yearbodyintNo
descriptionbodystringNo
start_datebodyDateTime?No
end_datebodyDateTime?No
registration_start_datebodyDateTime?No
registration_end_datebodyDateTime?No
drop_start_datebodyDateTime?No
drop_end_datebodyDateTime?No
add_start_datebodyDateTime?No
add_end_datebodyDateTime?No
grading_end_datebodyDateTime?No
duplicate_rates_from_previous_reporting_termbodystringNo

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

{
	authorizing_uuid: 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,
	duplicate_rates_from_previous_reporting_term: 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
	}
}