GetEnvironmentByEid (v2)

Overview

Reads a tenant based on its ID.

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
eid	String	Environment ID of the tenant we are looking for	Mandatory

Response

Parameters of the API response in getGroupsResponse type called return:

Parameter

Type

Description

status

GetEnvironmentResponse

Possible statusCodes:

- OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
- ERROR_NOT_FOUND

Examples

Example GetEnvironmentByEid transaction.

Example GetEnvironmentByEid transaction.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:getEnvironmentByEid>
         <token>CwF1v5KhYh9IP780249cgZjyRJuJe3xM</token>
         <eid>0000</eid>
      </v2:getEnvironmentByEid>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getEnvironmentByEidResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <environment>
               <displayName>Reference environment</displayName>
               <eid>0000</eid>
               <inactive>false</inactive>
               <shortName>Ref.</shortName>
               <helpdeskURL>http://help-menu-url.com</helpdeskURL> <!-- If this field is empty then it will not appear -->
               <!-- <ondemandMaxRowsInBufferPerUser></ondemandMaxRowsInBufferPerUser> -->
               <!-- <ondemandMaxCallAgeHoursInBuffer></ondemandMaxCallAgeHoursInBuffer> -->
            </environment>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:getEnvironmentByEidResponse>
   </S:Body>
</S:Envelope>