Overview
Returns an environment list.
The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|
| token | String | API authentication token | Mandatory |
| filter | EnvironmentFilter | Defines what environment to search for | Mandatory |
Response
Parameters of the API response:
| Parameter | Type | Description |
|---|
| environments | List<Environment> | Returned extensions (returned only if justCount in the filter parameter is false) |
| return | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
|
Examples
Example ListEnvironments transaction.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:listEnvironments>
<token>h0QNnaRB5dX5RXJUlcmiFT9MpKX2VPZT</token>
<filter>
<!-- use eid or shortName, but not both
<eid></eid>
<eidExact>0</eidExact>
-->
<!--
<shortName></shortName>
<shortNameExact>0</shortNameExact>
-->
<!-- As I used neither of them it will list all -->
<inactive>0</inactive>
</filter>
</v3:listEnvironments>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listEnvironmentsResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<environments>
<displayName>Reference environment</displayName>
<eid>0000</eid>
<helpdeskURL>http://valami.hu</helpdeskURL>
<inactive>false</inactive>
<shortName>Ref.</shortName>
</environments>
<environments>
<displayName>API test Environment</displayName>
<eid>0001</eid>
<helpdeskURL>http://help-menu-link.net</helpdeskURL>
<inactive>false</inactive>
<ondemandMaxCallAgeHoursInBuffer>72</ondemandMaxCallAgeHoursInBuffer>
<ondemandMaxRowsInBufferPerUser>24</ondemandMaxRowsInBufferPerUser>
<shortName>Tenant test shortname</shortName>
</environments>
<environments>
<displayName>API test Environment</displayName>
<eid>0002</eid>
<helpdeskURL>http://help-menu-link.net</helpdeskURL>
<inactive>false</inactive>
<ondemandMaxCallAgeHoursInBuffer>72</ondemandMaxCallAgeHoursInBuffer>
<ondemandMaxRowsInBufferPerUser>24</ondemandMaxRowsInBufferPerUser>
<shortName>Tenant test 2 shortname</shortName>
</environments>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:listEnvironmentsResponse>
</S:Body>
</S:Envelope>