regis

<back to all web services

ProvisionalRegistrationsForStudentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Provisional
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RegistrationDocumentResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val gender:String = null with get,set
        member val email:String = null with get,set
        member val program:String = null with get,set
        member val concentration:String = null with get,set
        member val section_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val course_title:String = null with get,set
        member val reporting_term:String = null with get,set
        member val document_code:String = null with get,set
        member val document_json:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ProvisionalRegistrationResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val student_name:String = null with get,set
        member val email:String = null with get,set
        member val section_uuid:String = null with get,set
        member val student_section_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val title:String = null with get,set
        member val term:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_waitlist:Boolean = new Boolean() with get,set
        member val is_missing_requisites:Boolean = new Boolean() with get,set
        member val is_other_restriction:Boolean = new Boolean() with get,set
        member val documents:ResizeArray<RegistrationDocumentResponse> = new ResizeArray<RegistrationDocumentResponse>() with get,set
        member val requested_date:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ProvisionalRegistrationsForStudentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val provisional_registrations:ResizeArray<ProvisionalRegistrationResponse> = new ResizeArray<ProvisionalRegistrationResponse>() with get,set

    [<AllowNullLiteral>]
    type ProvisionalRegistrationsForStudentRequest() = 
        member val uuid:String = null with get,set

F# 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
		}
	]
}