Skip to end of metadata
Go to start of metadata

Overview

Reads a tenant based on its ID.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
eidStringEnvironment ID of the tenant we are looking forMandatory

Response

Parameters of the API response in getGroupsResponse type called return:

ParameterType

Description

statusGetEnvironmentResponse

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:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:getEnvironmentByEid>
         <token>CwF1v5KhYh9IP780249cgZjyRJuJe3xM</token>
         <eid>0000</eid>
      </v3:getEnvironmentByEid>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getEnvironmentByEidResponse xmlns:ns2="http://v3.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>