The GET verb on the Environment API endpoint allows you to find an Enterprise Toolkit account that matches the supplied criteria.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. 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, so 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 GET verb on the Environment API returns the details of the Enterprise Toolkit environment matching the given parameters. The required and optional parameters for a GET call to the Environment API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Id | Integer | The other Enterprise Toolkit account’s unique identifier | ✓ |
| IntegrationKey | String | Your Enterprise Toolkit account’s unique integration key | ✓ |
| MasterId | Integer | Your Enterprise Toolkit account’s unique identifier | ✓ |
Example
Given that the API is REST-based, you can access it 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/environment?format=xml&Id=67503&IntegrationKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&MasterId=xxxxxXML Response
<EnvironmentSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<TotalRows>2</TotalRows>
<Environment>
<Environment>
<IntegrationKey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</IntegrationKey>
<MasterId>xxxxx</MasterId>
<ActiveDevices>0</ActiveDevices>
<BillType>Default</BillType>
<Country>ZA</Country>
<DateFormat>dd-MM-yyyy</DateFormat>
<Description>test environment</Description>
<FillRepeatRows>true</FillRepeatRows>
<GlobalDataSourceGETUrl>http://somewhere.com</GlobalDataSourceGETUrl>
<Id>xxxxx</Id>
<LastUpdated>2020-08-13T12:37:28.7Z</LastUpdated>
<LastUpdatedBy>User, Example</LastUpdatedBy>
<Metadata>
<KeyValue>
<Key>PAYROLLID</Key>
<Val>123456</Val>
</KeyValue>
</Metadata>
<Name>Environment 1</Name>
<Status>Active</Status>
<TimeFormat>HH:mm:ss tt</TimeFormat>
<TimeZone>South Africa Standard Time</TimeZone>
<TimeZoneOffSet>120</TimeZoneOffSet>
</Environment>
<Environment>
<IntegrationKey>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</IntegrationKey>
<MasterId>xxxxx</MasterId>
<ActiveDevices>0</ActiveDevices>
<BillType>Default</BillType>
<Country>ZA</Country>
<DateFormat>dd-MM-yyyy</DateFormat>
<Description>Test Environment 2</Description>
<FillRepeatRows>true</FillRepeatRows>
<GlobalDataSourceGETUrl>http://somewhere.com</GlobalDataSourceGETUrl>
<Id>xxxxx</Id>
<LastUpdated>2020-08-13T13:40:01.3Z</LastUpdated>
<LastUpdatedBy>User, Example</LastUpdatedBy>
<Metadata>
<KeyValue>
<Key>PAYROLLID</Key>
<Val>123456</Val>
</KeyValue>
</Metadata>
<Name>Environment 2</Name>
<Status>Active</Status>
<TimeFormat>HH:mm:ss tt</TimeFormat>
<TimeZone>South Africa Standard Time</TimeZone>
<TimeZoneOffSet>120</TimeZoneOffSet>
</Environment>
</Environment>
</EnvironmentSearchResponse>