regis

<back to all web services

InstitutionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create
import java.math.*
import java.util.*
import net.servicestack.client.*


open class InstitutionCreateRequest
{
    var institution_name:String? = null
    var institution_other_names:String? = null
    var institution_previous_names:String? = null
    var institution_type:String? = null
    var accreditation_status:String? = null
    var accreditation_status_notes:String? = null
    var accreditation_status_changed_date:Date? = null
    var gpa_conversion:String? = null
    var credit_hour_conversion:String? = null
    var authorizing_uuid:String? = null
}

open class InstitutionResponse
{
    var responseStatus:ResponseStatus? = null
    var institution_id:Int? = null
    var institution_name:String? = null
    var institution_previous_names:String? = null
    var institution_other_names:String? = null
    var institution_type:String? = null
    var accreditation_status:String? = null
    var accreditation_status_notes:String? = null
    var related_institutions:ArrayList<String> = ArrayList<String>()
    var accreditation_status_changed_date:Date? = null
    var gpa_conversion:String? = null
    var credit_hour_conversion:String? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var zip:String? = null
}

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

{
	institution_name: String,
	institution_other_names: String,
	institution_previous_names: String,
	institution_type: String,
	accreditation_status: String,
	accreditation_status_notes: String,
	accreditation_status_changed_date: 0001-01-01,
	gpa_conversion: String,
	credit_hour_conversion: String,
	authorizing_uuid: 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
}