Skip to end of metadata
Go to start of metadata

Overview

Updates an environment.

The function is available as a Web Service request.

Request

Parameters of the API request:


ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
environmentEnvironmentUpdated environment valuesMandatory

Response

Parameters of the API response:

ParameterType

Description

returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED

Examples


 Example UpdateEnvironment transaction.
Example UpdateEnvironment 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:updateEnvironment>
         <token>qJwKFPZ2wb2LPhcZbwhHh674Yu2rQtIv</token>
         <environment>
           <eid>0001</eid>
            <displayName>DisplayName</displayName>
            <helpdeskURL>www.thiat.net</helpdeskURL>
            <inactive>0</inactive>
            <ondemandMaxCallAgeHoursInBuffer>60</ondemandMaxCallAgeHoursInBuffer>
            <ondemandMaxRowsInBufferPerUser>60</ondemandMaxRowsInBufferPerUser>
            <!--Zero or more repetitions:-->
            <partitions>1000</partitions>
		    <partitions>2000</partitions>
		    <partitions>3000</partitions>
            <shortName>ShortName</shortName>
         </environment>
      </v3:updateEnvironment>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:updateEnvironmentResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <statusCode>OK</statusCode>
         </return>
      </ns2:updateEnvironmentResponse>
   </S:Body>
</S:Envelope>