To search for and retrieve multiple Environments at once, use a GET with the Search API found at our API Explorer.
On the Cloud, this API is available via SSL-secured HTTPS connection using the GET verb. The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/environment/search?format=xml/json
You may use either JSON or XML formats in your DELETE 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.
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/search | Model Description/Schema & Parameters |
Parameters
The GET verb allows you to retrieve multiple Environments, identified by your unique MasterId. The required and optional parameters for a GET call to the Environment Search API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| MasterId | Integer | Your unique Enterprise Toolkit account identifier | ✓ |
| IntegrationKey | String | Your unique integration key | ✓ |
| Name | String | Enterprise Toolkit account name to search for | |
| Status | String | Search for Enterprise Toolkit account in status | |
| PageNo | Integer | The page number from which to start reading results (0 based) | |
| PageSize | Integer | The page size (number of rows) to return. Maximum allowable value is 250. |
Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.
Request URL
https://eforms.mobileform.net:443/api/v2/environment/search?format=xml&MasterId=xxxxx&IntegrationKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&Name=EnvironmentResponse Body (XML)
<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>