GetEnvironmentByShortName (v2)

Overview

Reads a tenant based on its short name.

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
shortName	String	Environment short name of the tenant we are looking for	Mandatory

Response

Parameters of the API response in GetEnvironmentByShortName type called return:

Parameter

Type

Description

status

GetEnvironmentResponse

Possible statusCodes:

- OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
- ERROR_NOT_FOUND

Examples

Example GetEnvironmentByShortName transaction.

Example GetEnvironmentByShortName 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:getEnvironmentByShortName>
         <token>xjK9AVj1Lc4ciA4tBxEelKBrC5astJYj</token>
         <shortName>Ref.</shortName>
      </v2:getEnvironmentByShortName>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getEnvironmentByShortNameResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <environment>
               <displayName>Reference environment</displayName>
               <eid>0000</eid>
               <helpdeskURL>http://valami.hu</helpdeskURL>
               <inactive>false</inactive>
               <shortName>Ref.</shortName>
            </environment>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:getEnvironmentByShortNameResponse>
   </S:Body>
</S:Envelope>