DeleteGroup (v3)

Overview

Deletes a Group.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
groupIdIntegerDeleteable group's idMandatory

Response

Parameters of the API response in DeleteGroup type called return:

ParameterType

Description

statusStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED

Examples


 Example DeleteGroup transaction.
Example DeleteGroup 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:deleteGroup>
         <token>oJYrqC0mSEEmHEoO9tcMBOV3NKJLvmyS</token>
         <groupId>10</groupId>
      </v3:deleteGroup>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:deleteGroupResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <statusCode>OK</statusCode>
         </return>
      </ns2:deleteGroupResponse>
   </S:Body>
</S:Envelope>
 Example DeleteGroup transaction. The Default group is not deleteable.
Example DeleteGroup transaction. The Default group is not deleteable.
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:deleteGroup>
         <token>oJYrqC0mSEEmHEoO9tcMBOV3NKJLvmyS</token>
         <groupId>1</groupId>
      </v3:deleteGroup>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:deleteGroupResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <message>This is the default group and so it can not be deleted.</message>
            <statusCode>ERROR_ILLEGAL_ARGUMENT</statusCode>
         </return>
      </ns2:deleteGroupResponse>
   </S:Body>
</S:Envelope>