regis

<back to all web services

PersonKeyRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/keys
PersonKeyRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idbodyintNo
uuidbodystringNo
regent_loginbodystringNo
regent_network_loginbodystringNo
PersonKeyResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
re_idformintNo
sugar_idformstringNo
uuidformstringNo
student_idformint?No
regent_loginformstringNo

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

{
	regent_id: 0,
	uuid: String,
	regent_login: String,
	regent_network_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
		}
	},
	regent_id: 0,
	re_id: 0,
	sugar_id: String,
	uuid: String,
	student_id: 0,
	regent_login: String
}