regis

<back to all web services

ProvisionalRegistrationsForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Provisional
import Foundation
import ServiceStack

public class ProvisionalRegistrationsForStudentRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class ProvisionalRegistrationsForStudentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var provisional_registrations:[ProvisionalRegistrationResponse] = []

    required public init(){}
}

public class ProvisionalRegistrationResponse : Codable
{
    public var uuid:String
    public var regent_id:Int?
    public var student_name:String
    public var email:String
    public var section_uuid:String
    public var student_section_uuid:String
    public var course_name:String
    public var section_code:String
    public var title:String
    public var term:String
    public var amount:Double
    public var is_audit:Bool
    public var is_waitlist:Bool
    public var is_missing_requisites:Bool
    public var is_other_restriction:Bool
    public var documents:[RegistrationDocumentResponse] = []
    public var requested_date:Date

    required public init(){}
}

public class RegistrationDocumentResponse : Codable
{
    public var uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var gender:String
    public var email:String
    public var program:String
    public var concentration:String
    public var section_uuid:String
    public var course_name:String
    public var course_title:String
    public var reporting_term:String
    public var document_code:String
    public var document_json:String
    public var document_name:String
    public var document_description:String
    public var added_date:Date?
    public var changed_date:Date?

    required public init(){}
}


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

{
	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
		}
	},
	regent_id: 0,
	uuid: String,
	provisional_registrations: 
	[
		{
			uuid: String,
			regent_id: 0,
			student_name: String,
			email: String,
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_waitlist: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			documents: 
			[
				{
					uuid: String,
					regent_id: 0,
					first_name: String,
					last_name: String,
					gender: String,
					email: String,
					program: String,
					concentration: String,
					section_uuid: String,
					course_name: String,
					course_title: String,
					reporting_term: String,
					document_code: String,
					document_json: String,
					document_name: String,
					document_description: String,
					added_date: 0001-01-01,
					changed_date: 0001-01-01
				}
			],
			requested_date: 0001-01-01
		}
	]
}