Six4Win.WebApi

<back to all web services

ScheduleStimulation

Requires Authentication
The following routes are available for this service:
All Verbs/cmd/stimulations/schedule
ScheduleStimulation Parameters:
NameParameterData TypeRequiredDescription
IdquerystringNo
TargetqueryRefNo
PoolqueryRefNo
Ref Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
ValformstringYes

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 /cmd/stimulations/schedule HTTP/1.1 
Host: s4w2.api.bengabet.webhop.biz 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	target: 
	{
		id: String,
		val: String
	},
	pool: 
	{
		id: String,
		val: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}