regis

<back to all web services

InstitutionsRequest

Requires Authentication
Required permission:ReadInstitutions
The following routes are available for this service:
POST/institutions/{institution_name}
InstitutionsRequest Parameters:
NameParameterData TypeRequiredDescription
institution_namepathstringNo

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

{
	institution_name: 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
			}
		},
		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
	}
]