regis

<back to all web services

UnauthenticatedRegistrationTransactionUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Unauthenticated/{reporting_term}/{transaction_uuid}/Update
import Foundation
import ServiceStack

public class UnauthenticatedRegistrationTransactionUpdateRequest : Codable
{
    public var transaction_uuid:String
    public var reporting_term:String
    public var is_authorized:Bool
    public var is_archived:Bool
    public var authorizing_uuid:String

    required public init(){}
}

public class UnauthenticatedRegistrationTransactionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var transaction_uuid:String
    public var notes_json:String
    public var credit_hours:Double
    public var audit_hours:Double
    public var started_datetime:Date
    public var archived_datetime:Date?
    public var submitted_datetime:Date?
    public var authorized_datetime:Date?
    public var person:UnauthenticatedPersonResponse
    public var registrations:[UnauthenticatedStudentSectionRegistrationResponse] = []

    required public init(){}
}

public class UnauthenticatedPersonResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int?
    public var reporting_term:String
    public var survey:String
    public var friend_referral:String
    public var other_referral:String
    public var is_returning:Bool
    public var is_applying:Bool
    public var is_landlord:Bool
    public var postsecondary_education_level:Int
    public var uuid:String
    public var regent_login:String
    public var first_name:String
    public var middle_name:String
    public var last_name:String
    public var preferred_name:String
    public var birth_name:String
    public var spouse_name:String
    public var addr1:String
    public var addr2:String
    public var country:String
    public var state:String
    public var city:String
    public var code:String
    public var phone_home:String
    public var phone_cell:String
    public var phone_bus:String
    public var email:String
    public var `prefix`:String
    public var dob:Date?
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var denomination:String
    public var occupation:String
    public var ethnicity:String
    public var gender:String
    public var marital_status:String
    public var deceased_date:Date?
    public var added_by:String
    public var added_date:Date?
    public var last_changed_by:String
    public var last_changed_date:Date?
    public var addr_last_changed_by:String
    public var addr_last_changed_date:Date?
    public var timestamp:Date
    public var submitted_datetime:Date?
    public var submitted_by_unauthenticated_person_id:Int?
    public var authorized_datetime:Date?
    public var authorized_by_person_id:Int?
    public var archived_datetime:Date?
    public var archived_by_person_id:Int?

    required public init(){}
}

public class UnauthenticatedStudentSectionRegistrationResponse : Codable
{
    public var section_uuid:String
    public var student_section_uuid:String
    public var course_name:String
    public var section_code:String
    public var course_title:String
    public var amount:Double
    public var is_oncampus:Bool
    public var is_audit:Bool
    public var is_provisional:Bool
    public var is_missing_requisites:Bool
    public var is_other_restriction:Bool
    public var added_date:Date?
    public var added_by_person_id:Int?
    public var changed_date:Date?
    public var changed_by_person_id:Int?

    required public init(){}
}


Swift UnauthenticatedRegistrationTransactionUpdateRequest 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}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	transaction_uuid: String,
	reporting_term: String,
	is_authorized: False,
	is_archived: False,
	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
		}
	]
}