regis

<back to all web services

PersonCreateRequest

Requires Authentication
Required permission:CreatePerson
The following routes are available for this service:
POST/person/create
PersonCreateRequest Parameters:
NameParameterData TypeRequiredDescription
first_namebodystringNo
middle_namebodystringNo
last_namebodystringNo
preferred_namebodystringNo
birth_namebodystringNo
prefixbodystringNo
addr1bodystringNo
addr2bodystringNo
countrybodystringNo
statebodystringNo
citybodystringNo
codebodystringNo
phone_homebodystringNo
phone_cellbodystringNo
phone_busbodystringNo
emailbodystringNo
dobbodyDateTime?No
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
denominationbodystringNo
occupationbodystringNo
ethnicitybodystringNo
genderbodystringNo
marital_statusbodystringNo
deceased_datebodyDateTime?No
do_not_queue_for_crmbodyboolNo
authorizing_uuidbodystringNo
PersonCreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo

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

{
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	birth_name: String,
	prefix: String,
	addr1: String,
	addr2: String,
	country: String,
	state: String,
	city: String,
	code: String,
	phone_home: String,
	phone_cell: String,
	phone_bus: String,
	email: String,
	dob: 0001-01-01,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	denomination: String,
	occupation: String,
	ethnicity: String,
	gender: String,
	marital_status: String,
	deceased_date: 0001-01-01,
	do_not_queue_for_crm: False,
	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
		}
	},
	regent_id: 0,
	uuid: String
}