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/environment?format=xml/json
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.
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/environment | Model Description/Schema & Parameters |
Parameters #
The POST verb on the Environment API allows you to create a new environment in your Enterprise Toolkit Master account. The required and optional parameters for a POST call to the User API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Name | String | Name of the new environment you want to create | ✓ |
| Description | String | A description of the new environment you want to create | ✓ |
| Country | String | The ISO 3166-2 code for this Enterprise Toolkit account’s base country. | |
| TimeZone | String | Name of timezone, must match exactly with one of the values in this list | |
| DateFormat | String | ||
| TimeFormat | String | ||
| FillRepeatRows | Boolean | Whether or not to copy down repeatable answer values when exporting repeatable data to tabular formats like CSV | |
| SendInviteEmailsTo | String | ||
| DefaultSenderEmail | String | The email address to use as the default for emails sent from the platform by this Enterprise Toolkit account | |
| DefaultSenderName | String | The sender name to use as the default for emails sent from the platform by this Enterprise Toolkit account | |
| GlobalFormRESTUrl | String | ||
| GlobalTaskRESTUrl | String | ||
| GlobalDataSourceGETUrl | String | ||
| RetireDate | Date | ||
| Industry | String | ||
| AddSupportUser | Boolean | Whether or not to automatically create a support user as part of the Enterprise Toolkit creation | |
| SupportUserEmail | String | Allows you to specify the email address of the support user to be created. If blank, then DefaultSenderEmail is used. | |
| CopyCustomIcons | Boolean | By default, custom icons are not copied into new contexts. Set to ‘True’ to preserve the custom icon settings. | |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
| MasterId | Integer | The Organization ID of your Master account. | ✓ |
Example
Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://eforms.mobileform.net:443/api/v2/environmentRequest Body
{
"Name": "UK Environment",
"Description": "New Location Environment",
"Country": "GB",
"TimeZone": "GMT Standard Time",
"DateFormat": "dd-MM-yyyy",
"TimeFormat": "HH:mm",
"DefaultSenderEmail": "defaultsender@testorg.com",
"DefaultSenderName": "Support User",
"Industry": "Industry Example",
"AddSupportUser": true,
"SupportUserEmail": "supportuser@testorg.com",
"IntegrationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"MasterId": xxxxx
}Response Code
200Response Body
{
"Environment": {
"Id": xxxxx,
"TimeZoneOffSet": 0,
"Status": "Active",
"IntegrationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"MasterId": xxxxx
},
"SupportUser": {
"Id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Type": "Premium",
"FirstName": "Environment",
"LastName": "Support",
"Email": "defaultsender@testorg.com",
"Status": "Invited",
"TimeZone": "GMT Standard Time",
"TimeZoneOffSet": 60,
"Country": "GB",
"CreatedDate": "2020-08-18T13:51:24.7204761Z",
"LastUpdated": "2020-08-18T13:51:24.7517519Z",
"LastActivity": "1990-01-01T00:00:01.0000000Z",
"Folders": ["Test Folder", "Admin Folder", "User Folder"],
"Groups": ["Test Group", "Admin Group", "User Group"],
"CompanyId": xxxxx
}
}