To create an Environment account, use a POST with the Environment API found at our API Explorer.
On our Cloud service, this API is available via SSL secured HTTPS connection using the REST GET, POST and PUT verbs.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/company?format=xml/json
NOTE: This API endpoint implements pagination, and as such you must cater for this when you connect to our platform.
You can learn more about pagination in our API overview.
POST Request
The POST verb allows you to create a new Environment on the platform.
You may use either JSON or XML formats in your request.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”. If no ContentType is specified, XML format is assumed.
The required and optional parameters for a POST to the Environment API are outlined below.
Note that if you wish to automatically create a support user for your internal use with this Environment, you should set the AddSupportUser property on Environment to be True.
| Parameter Name | Data Type | Required | Description |
| Environment | Environment |
Yes | The Environment that you wish to create. See the Environment type definition from the GET documentation topic. |
POST Response
The data returned from an Environment POST is provided as follows:
Environment Response
| Field Name | Data Type | Description |
| Environment | Environment | The Environment created |
| SupportUser | User |
The support User created (if any). See User documentation for full details of this structure. |
| ResponseStatus | ResponseStatus |
Details of any errors that may have occurred |
Environment
| Field Name | Data Type |
Description |
| Id |
Integer |
Unique Environment Id (Company Id) found on the Organisation Setup page>Integrations Settings of the secure website. |
| TimeZoneOffSet | Integer |
The value the timezone is offset by. |
| Status | String |
Describes the Environment’s current status.
|