regis

<back to all web services

PersonVerySimpleRequest

Requires Authentication
Required permission:ReadStudentStatus
The following routes are available for this service:
POST/person/regent_login/{regent_login}
PersonVerySimpleRequest Parameters:
NameParameterData TypeRequiredDescription
regent_loginpathstringNo
PersonVerySimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
first_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
emailformstringNo

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 /person/regent_login/{regent_login} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_login: 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
		}
	},
	first_name: String,
	last_name: String,
	preferred_name: String,
	email: String
}