regis

DropRegistrationsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/{uuid}/Drop/{reporting_term}

**DropRegistrationsRequest** Parameters:
Name	Parameter	Data Type	Required
uuid	path	string	No
reporting_term	path	string	No
registrations	body	List<DropRegistrationResponse>	No
override_drop_date	body	DateTime?	No
authorizing_uuid	body	string	No

**DropRegistrationResponse** Parameters:
Name	Parameter	Data Type	Required
student_section_uuid	form	string	No
course_name	form	string	No
section_code	form	string	No
title	form	string	No
term	form	string	No
amount	form	decimal	No
is_audit	form	bool	No
is_grade_final	form	bool	No
is_provisional	form	bool	No
is_selected_to_drop	form	bool	No
suggested_refund_percentage	form	decimal	No
suggested_refund_amount	form	decimal	No
balance_amount	form	decimal	No
charge_amount	form	decimal	No
credit_amount	form	decimal	No
description	form	string	No
additional_rate_description	form	string	No
additional_rate_id	form	int?	No
additional_rate_amount	form	decimal?	No
additional_rate_suggested_refund_percentage	form	decimal?	No
additional_rate_suggested_refund_amount	form	decimal?	No
benefit_description	form	string	No
second_benefit_description	form	string	No
benefit_rate_id	form	int?	No
benefit_amount	form	decimal?	No
second_benefit_amount	form	decimal?	No
second_benefit_rate_id	form	int?	No

**DropRegistrationsResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
transaction_uuid	form	string	No
regent_id	form	int	No
uuid	form	string	No
reporting_term	form	string	No
suggested_drop_fee	form	decimal	No
suggested_full_student_fee_refund	form	bool	No
messages	form	List<string>	No
registrations	form	List<DropRegistrationResponse>	No
invoiceItemBalances	form	List<InvoiceItemBalanceResponse>	No

**InvoiceItemBalanceResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
rate_id	form	int	No
rate_code	form	string	No
rate_description	form	string	No
balance_amount	form	decimal	No
charge_amount	form	decimal	No
credit_amount	form	decimal	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} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	reporting_term: String,
	registrations: 
	[
		{
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_grade_final: False,
			is_provisional: False,
			is_selected_to_drop: False,
			suggested_refund_percentage: 0,
			suggested_refund_amount: 0,
			balance_amount: 0,
			charge_amount: 0,
			credit_amount: 0,
			description: String,
			additional_rate_description: String,
			additional_rate_id: 0,
			additional_rate_amount: 0,
			additional_rate_suggested_refund_percentage: 0,
			additional_rate_suggested_refund_amount: 0,
			benefit_description: String,
			second_benefit_description: String,
			benefit_rate_id: 0,
			benefit_amount: 0,
			second_benefit_amount: 0,
			second_benefit_rate_id: 0
		}
	],
	override_drop_date: 0001-01-01,
	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,
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	suggested_drop_fee: 0,
	suggested_full_student_fee_refund: False,
	messages: 
	[
		String
	],
	registrations: 
	[
		{
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_grade_final: False,
			is_provisional: False,
			is_selected_to_drop: False,
			suggested_refund_percentage: 0,
			suggested_refund_amount: 0,
			balance_amount: 0,
			charge_amount: 0,
			credit_amount: 0,
			description: String,
			additional_rate_description: String,
			additional_rate_id: 0,
			additional_rate_amount: 0,
			additional_rate_suggested_refund_percentage: 0,
			additional_rate_suggested_refund_amount: 0,
			benefit_description: String,
			second_benefit_description: String,
			benefit_rate_id: 0,
			benefit_amount: 0,
			second_benefit_amount: 0,
			second_benefit_rate_id: 0
		}
	],
	invoiceItemBalances: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			rate_id: 0,
			rate_code: String,
			rate_description: String,
			balance_amount: 0,
			charge_amount: 0,
			credit_amount: 0
		}
	]
}