regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}/Submit
import Foundation
import ServiceStack

public class AddRegistrationsSubmitRequest : Codable
{
    public var transaction_uuid:String
    public var uuid:String
    public var reporting_term:String
    public var Description:String
    public var email_student:Bool
    public var registrations:[AddRegistrationWithBenefitRequest] = []
    public var additional_term_charges:[AddRegistrationsAdditionalChargeSubmitRequest] = []
    public var authorizing_uuid:String

    required public init(){}
}

public class AddRegistrationWithBenefitRequest : Codable
{
    public var student_section_uuid:String
    public var Description:String
    public var amount:Double
    public var charge:Double
    public var is_audit:Bool
    public var benefit_id:Int?
    public var benefit_amount:Double?
    public var second_benefit_id:Int?
    public var second_benefit_amount:Double?

    required public init(){}
}

public class AddRegistrationsAdditionalChargeSubmitRequest : Codable
{
    public var rate_id:Int
    public var Description:String
    public var charge:Double
    public var credit:Double

    required public init(){}
}


Swift AddRegistrationsSubmitRequest 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}/Add/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	transaction_uuid: String,
	uuid: String,
	reporting_term: String,
	description: String,
	email_student: False,
	registrations: 
	[
		{
			student_section_uuid: String,
			description: String,
			amount: 0,
			charge: 0,
			is_audit: False,
			benefit_id: 0,
			benefit_amount: 0,
			second_benefit_id: 0,
			second_benefit_amount: 0
		}
	],
	additional_term_charges: 
	[
		{
			rate_id: 0,
			description: String,
			charge: 0,
			credit: 0
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}