regis

<back to all web services

UnauthenticatedRegistrationTransactionRequest

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

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

    [<AllowNullLiteral>]
    type UnauthenticatedPersonResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val reporting_term:String = null with get,set
        member val survey:String = null with get,set
        member val friend_referral:String = null with get,set
        member val other_referral:String = null with get,set
        member val is_returning:Boolean = new Boolean() with get,set
        member val is_applying:Boolean = new Boolean() with get,set
        member val is_landlord:Boolean = new Boolean() with get,set
        member val postsecondary_education_level:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val regent_login:String = null with get,set
        member val first_name:String = null with get,set
        member val middle_name:String = null with get,set
        member val last_name:String = null with get,set
        member val preferred_name:String = null with get,set
        member val birth_name:String = null with get,set
        member val spouse_name:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val country:String = null with get,set
        member val state:String = null with get,set
        member val city:String = null with get,set
        member val code:String = null with get,set
        member val phone_home:String = null with get,set
        member val phone_cell:String = null with get,set
        member val phone_bus:String = null with get,set
        member val email:String = null with get,set
        member val prefix:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val citizenship:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val denomination:String = null with get,set
        member val occupation:String = null with get,set
        member val ethnicity:String = null with get,set
        member val gender:String = null with get,set
        member val marital_status:String = null with get,set
        member val deceased_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_changed_by:String = null with get,set
        member val last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val addr_last_changed_by:String = null with get,set
        member val addr_last_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val timestamp:DateTime = new DateTime() with get,set
        member val submitted_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val submitted_by_unauthenticated_person_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val authorized_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val authorized_by_person_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val archived_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val archived_by_person_id:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type UnauthenticatedStudentSectionRegistrationResponse() = 
        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 course_title:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val is_oncampus:Boolean = new Boolean() with get,set
        member val is_audit:Boolean = new Boolean() with get,set
        member val is_provisional: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 added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by_person_id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by_person_id:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type UnauthenticatedRegistrationTransactionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val transaction_uuid:String = null with get,set
        member val notes_json:String = null with get,set
        member val credit_hours:Decimal = new Decimal() with get,set
        member val audit_hours:Decimal = new Decimal() with get,set
        member val started_datetime:DateTime = new DateTime() with get,set
        member val archived_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val submitted_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val authorized_datetime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val person:UnauthenticatedPersonResponse = null with get,set
        member val registrations:ResizeArray<UnauthenticatedStudentSectionRegistrationResponse> = new ResizeArray<UnauthenticatedStudentSectionRegistrationResponse>() with get,set

    [<AllowNullLiteral>]
    type UnauthenticatedRegistrationTransactionRequest() = 
        member val reporting_term:String = null with get,set
        member val transaction_uuid:String = null with get,set
        member val authorizing_uuid:String = null with get,set

F# UnauthenticatedRegistrationTransactionRequest 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/Unauthenticated/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	transaction_uuid: String,
	authorizing_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
		}
	},
	transaction_uuid: String,
	notes_json: String,
	credit_hours: 0,
	audit_hours: 0,
	started_datetime: 0001-01-01,
	archived_datetime: 0001-01-01,
	submitted_datetime: 0001-01-01,
	authorized_datetime: 0001-01-01,
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		reporting_term: String,
		survey: String,
		friend_referral: String,
		other_referral: String,
		is_returning: False,
		is_applying: False,
		is_landlord: False,
		postsecondary_education_level: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		middle_name: String,
		last_name: String,
		preferred_name: String,
		birth_name: String,
		spouse_name: String,
		addr1: String,
		addr2: String,
		country: String,
		state: String,
		city: String,
		code: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		email: String,
		prefix: String,
		dob: 0001-01-01,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		denomination: String,
		occupation: String,
		ethnicity: String,
		gender: String,
		marital_status: String,
		deceased_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		last_changed_by: String,
		last_changed_date: 0001-01-01,
		addr_last_changed_by: String,
		addr_last_changed_date: 0001-01-01,
		timestamp: 0001-01-01,
		submitted_datetime: 0001-01-01,
		submitted_by_unauthenticated_person_id: 0,
		authorized_datetime: 0001-01-01,
		authorized_by_person_id: 0,
		archived_datetime: 0001-01-01,
		archived_by_person_id: 0
	},
	registrations: 
	[
		{
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			course_title: String,
			amount: 0,
			is_oncampus: False,
			is_audit: False,
			is_provisional: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			added_date: 0001-01-01,
			added_by_person_id: 0,
			changed_date: 0001-01-01,
			changed_by_person_id: 0
		}
	]
}