regis

<back to all web services

OrganizationCreateRequest

Requires Authentication
Required permission:CreateOrganization
The following routes are available for this service:
POST/organization/create
OrganizationCreateRequest Parameters:
NameParameterData TypeRequiredDescription
organization_namebodystringNo
emailbodystringNo
addr1bodystringNo
addr2bodystringNo
citybodystringNo
statebodystringNo
countrybodystringNo
codebodystringNo
phone_homebodystringNo
phone_cellbodystringNo
phone_busbodystringNo
authorizing_uuidbodystringNo
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
organization_idformintNo
organization_nameformstringNo
emailformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
phone_cellformstringNo
phone_busformstringNo
phone_homeformstringNo
is_institutionformboolNo
is_vendorformboolNo
is_reformboolNo

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

{
	organization_name: String,
	email: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	phone_home: String,
	phone_cell: String,
	phone_bus: String,
	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
		}
	},
	organization_id: 0,
	organization_name: String,
	email: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	phone_cell: String,
	phone_bus: String,
	phone_home: String,
	is_institution: False,
	is_vendor: False,
	is_re: False
}