regis

<back to all web services

UnauthenticatedRegistrationInProgressSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressForUnauthenticatedPerson/{uuid}/Term/{reporting_term}/Submit
UnauthenticatedRegistrationInProgressSubmitRequest Parameters:
NameParameterData TypeRequiredDescription
transaction_uuidbodystringNo
uuidpathstringNo
reporting_termpathstringNo
rates_opted_inbodyList<int>No
casl_optinbodyboolNo
ams_optinbodyboolNo
rcsa_locker_optinbodyboolNo
appliedForDEReentryBenefitbodyboolNo
appliedForSpousalAuditBenefitbodyboolNo
appliedForSpousalCreditBenefitbodyboolNo
notesbodystringNo
RegistrationInProgressSubmitResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
emailformstringNo
first_nameformstringNo
preferred_nameformstringNo
last_nameformstringNo

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/InProgressForUnauthenticatedPerson/{uuid}/Term/{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,
	rates_opted_in: 
	[
		0
	],
	casl_optin: False,
	ams_optin: False,
	rcsa_locker_optin: False,
	appliedForDEReentryBenefit: False,
	appliedForSpousalAuditBenefit: False,
	appliedForSpousalCreditBenefit: False,
	notes: 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
		}
	},
	email: String,
	first_name: String,
	preferred_name: String,
	last_name: String
}