regis

RegistrationInProgressSummaryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST	/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_uuid}

import Foundation
import ServiceStack

public class RegistrationInProgressSummaryRequest : Codable
{
    public var uuid:String
    public var transaction_uuid:String
    public var reporting_term:String
    public var online_only:Bool

    required public init(){}
}

public class RegistrationInProgressSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var transaction_uuid:String
    public var regent_id:Int
    public var uuid:String
    public var reporting_term:String
    public var numberOfStudentSections:Int
    public var amountOwing:Double
    public var mustPayBeforeRegistering:Bool
    public var requiredDocuments:[RegistrationDocumentResponse] = []
    public var completedDocuments:[RegistrationDocumentResponse] = []
    public var isLate:Bool

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

{
	uuid: String,
	transaction_uuid: String,
	reporting_term: String,
	online_only: False
}

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
		}
	},
	transaction_uuid: String,
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	numberOfStudentSections: 0,
	amountOwing: 0,
	mustPayBeforeRegistering: False,
	requiredDocuments: 
	[
		{
			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
		}
	],
	completedDocuments: 
	[
		{
			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
		}
	],
	isLate: False
}