regis

<back to all web services

DropRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Drop/{reporting_term}/Submit
DropRegistrationsSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
transaction_uuidbodystringNo
uuidpathstringNo
reporting_termpathstringNo
registrationsbodyList<DropRegistrationSubmitRequest>No
descriptionbodystringNo
drop_feebodydecimal?No
drop_descriptionbodystringNo
refund_student_feesbodyboolNo
authorizing_uuidbodystringNo
DropRegistrationSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
student_section_uuidformstringNo
tuition_refund_amountformdecimalNo
descriptionformstringNo
additional_rate_idformint?No
additional_rate_amountformdecimal?No
benefit_rate_idformint?No
second_benefit_rate_idformint?No
benefit_charge_amountformdecimal?No
second_benefit_charge_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}/Drop/{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,
	registrations: 
	[
		{
			student_section_uuid: String,
			tuition_refund_amount: 0,
			description: String,
			additional_rate_id: 0,
			additional_rate_amount: 0,
			benefit_rate_id: 0,
			second_benefit_rate_id: 0,
			benefit_charge_amount: 0,
			second_benefit_charge_amount: 0
		}
	],
	description: String,
	drop_fee: 0,
	drop_description: String,
	refund_student_fees: False,
	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
	}
}