up

Help

Documentation of the API.

Get help information (this)

The documentation you are reading right now can also be fetched using the API. This is where you do that; but please, use sparingly as it is a very expensive method.

HTTP method: GET
http://api.sendcastle.com/v1/help/[str]
cURL example
curl http://api.sendcastle.com/v1/help/[str] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'help.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
Change help information (this)

The documentation you are reading right now can also be fetched using the API. This is where you do that; but please, use sparingly as it is a very expensive method.

HTTP method: POST
http://api.sendcastle.com/v1/help/[123]
http://api.sendcastle.com/v1/help/[all]
cURL example
curl http://api.sendcastle.com/v1/help/[123] \
	--data '{"id":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Identifier can be an integer or 'all'
  • Additional parameters required: id
  • No extra security requirements
  • Requires write access
  • VC_VRONOIT
  • VC_VRO
Create help information (this)

The documentation you are reading right now can also be fetched using the API. This is where you do that; but please, use sparingly as it is a very expensive method.

HTTP method: PUT
http://api.sendcastle.com/v1/help/[123]
http://api.sendcastle.com/v1/help/[all]
cURL example
curl http://api.sendcastle.com/v1/help/[123] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • No additional parameters required, unless stated elsewhere
  • Requires create access
Get tooltip information for UI

The tooltip help in SendCastle's UI is also accessible via the API but is probably of little use to external applications.

HTTP method: GET
http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'help.tooltip'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
Change tooltip information for UI

The tooltip help in SendCastle's UI is also accessible via the API but is probably of little use to external applications.

HTTP method: POST
http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy] \
	--data '{"id":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Requires administrator access
  • Identifier should be an integer
  • Additional parameters required: id
  • No extra security requirements
  • Requires write access
  • VC_VRONOIT
  • VC_VRO
Create tooltip information for UI

The tooltip help in SendCastle's UI is also accessible via the API but is probably of little use to external applications.

HTTP method: PUT
http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/tooltip/[yy] \
	--data '{"name":"fnurt","page":"fnurt","tooltip":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Requires administrator access
  • Identifier should be an integer
  • VC_VRONOIT
  • Additional parameters required: name, page, tooltip
  • Requires create access
Get contextual help for UI

There is contextual help in SendCastle's UI, this method facilitates working with these. It is probably of little use to external applications. At the time of writing, contextual help is only enabled on SOME accounts due to its implementation being tweaked.

HTTP method: GET
http://api.sendcastle.com/v1/help/[xx]/contextual/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/contextual/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'help.contextual'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer or 'all'
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
Change contextual help for UI

There is contextual help in SendCastle's UI, this method facilitates working with these. It is probably of little use to external applications. At the time of writing, contextual help is only enabled on SOME accounts due to its implementation being tweaked.

HTTP method: POST
http://api.sendcastle.com/v1/help/[xx]/contextual/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/contextual/[yy] \
	--data '{"id":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Requires administrator access
  • Identifier should be an integer
  • Additional parameters required: id
  • No extra security requirements
  • Requires write access
  • VC_VRONOIT
  • VC_VRO
Create contextual help for UI

There is contextual help in SendCastle's UI, this method facilitates working with these. It is probably of little use to external applications. At the time of writing, contextual help is only enabled on SOME accounts due to its implementation being tweaked.

HTTP method: PUT
http://api.sendcastle.com/v1/help/[xx]/contextual/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/contextual/[yy] \
	--data '{"name":"fnurt","help":"fnurt"}' \
-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Requires administrator access
  • Identifier should be an integer
  • VC_VRONOIT
  • Additional parameters required: name, help
  • Requires create access
Create contextual usage history

In order to give contextual help we store user actions, this method is used to store an action.

HTTP method: PUT
http://api.sendcastle.com/v1/help/[xx]/history/[yy]
cURL example
curl http://api.sendcastle.com/v1/help/[xx]/history/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires write access