regis

<back to all web services

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 java.math.*
import java.util.*
import net.servicestack.client.*


open class RegistrationInProgressSummaryRequest
{
    var uuid:String? = null
    var transaction_uuid:String? = null
    var reporting_term:String? = null
    var online_only:Boolean? = null
}

open class RegistrationInProgressSummaryResponse
{
    var responseStatus:ResponseStatus? = null
    var transaction_uuid:String? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var reporting_term:String? = null
    var numberOfStudentSections:Int? = null
    var amountOwing:BigDecimal? = null
    var mustPayBeforeRegistering:Boolean? = null
    var requiredDocuments:ArrayList<RegistrationDocumentResponse> = ArrayList<RegistrationDocumentResponse>()
    var completedDocuments:ArrayList<RegistrationDocumentResponse> = ArrayList<RegistrationDocumentResponse>()
    var isLate:Boolean? = null
}

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

Kotlin 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
}