regis

<back to all web services

InstitutionCreateFromOrganizationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create/FromOrganization/{organization_id}
import Foundation
import ServiceStack

public class InstitutionCreateFromOrganizationRequest : Codable
{
    public var organization_id:Int

    required public init(){}
}

public class InstitutionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var institution_id:Int
    public var institution_name:String
    public var institution_previous_names:String
    public var institution_other_names:String
    public var institution_type:String
    public var accreditation_status:String
    public var accreditation_status_notes:String
    public var related_institutions:[String] = []
    public var accreditation_status_changed_date:Date?
    public var gpa_conversion:String
    public var credit_hour_conversion:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var zip:String

    required public init(){}
}


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

{
	organization_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
}