VitalWare API

<back to all web services

Entity

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 /jsv/reply/Entity HTTP/1.1 
Host: api.vitalware.com 
Content-Type: text/jsv
Content-Length: length

{
	parentEntityId: 0,
	entityName: String,
	isTest: False,
	isTrial: False,
	phoneExt: String,
	phoneNumber: String,
	emailAddress: String,
	addressStreet: String,
	addressSecond: String,
	city: String,
	state: String,
	postalCode: String,
	url: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	entityId: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}