regis

<back to all web services

InstitutionRequest

Requires Authentication
Required permission:ReadInstitutions
The following routes are available for this service:
POST/institutions
InstitutionRequest Parameters:
NameParameterData TypeRequiredDescription
institution_idbodyintNo
InstitutionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
institution_idformintNo
institution_nameformstringNo
institution_previous_namesformstringNo
institution_other_namesformstringNo
institution_typeformstringNo
accreditation_statusformstringNo
accreditation_status_notesformstringNo
related_institutionsformList<string>No
accreditation_status_changed_dateformDateTime?No
gpa_conversionformstringNo
credit_hour_conversionformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
zipformstringNo

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

{
	institution_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
		}
	},
	institution_id: 0,
	institution_name: String,
	institution_previous_names: String,
	institution_other_names: String,
	institution_type: String,
	accreditation_status: String,
	accreditation_status_notes: String,
	related_institutions: 
	[
		String
	],
	accreditation_status_changed_date: 0001-01-01,
	gpa_conversion: String,
	credit_hour_conversion: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	zip: String
}