regis

<back to all web services

AddProvisionalRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/AddProvisional/{reporting_term}/Submit
AddProvisionalRegistrationsSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
transaction_uuidbodystringNo
uuidpathstringNo
reporting_termpathstringNo
email_studentbodyboolNo
registrationsbodyList<AddRegistrationWithBenefitRequest>No
authorizing_uuidbodystringNo
AddRegistrationWithBenefitRequest Parameters:
NameParameterData TypeRequiredDescription
student_section_uuidformstringNo
descriptionformstringNo
amountformdecimalNo
chargeformdecimalNo
is_auditformboolNo
benefit_idformint?No
benefit_amountformdecimal?No
second_benefit_idformint?No
second_benefit_amountformdecimal?No

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}/AddProvisional/{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,
	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
		}
	],
	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
	}
}