CreateGroup (v3)
Kiss, Mate
Owned by Kiss, Mate
Mar 03, 2023
15 min read
Loading data...
Overview
Creates a new Group.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 |
| group | Group | New group's properties | Mandatory |
Response
Parameters of the API response in getGroupsResponse type called return:
| Parameter | Type | Description |
|---|---|---|
| status | Status | Possible return values:
|
| group | Group |
Examples
 Example createGroup transaction.
Example createGroup 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:createGroup>
<token>T1R5Ur6AKmaoGemf6LG8EUZLFa67lX1U</token>
<group>
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName>?</environmentShortName>
-->
<name>API test group</name>
<nonModifiable>0</nonModifiable>
</group>
</v3:createGroup>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createGroupResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>6</id>
<name>API test group</name>
<nonModifiable>false</nonModifiable>
</group>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:createGroupResponse>
</S:Body>
</S:Envelope>
 Example createGroup transaction. Assigning one admin user, one supervisor user, 2 standard users.
Example createGroup transaction. Assigning one admin user, one supervisor user, 2 standard users.
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:createGroup>
<token>cUlVuDEkuu5w9jutzl2y4zfjBoh7gpOf</token>
<group>
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName></environmentShortName>
-->
<name>Nest group</name>
<nonModifiable>0</nonModifiable>
<!--Zero or more repetitions:-->
<users> <!-- standard user -->
<admin>0</admin>
<member>1</member>
<primary>0</primary>
<supervisor>0</supervisor>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<user>
<id>6</id>
</user>
</users>
<users> <!-- standard user -->
<admin>0</admin>
<member>1</member>
<primary>0</primary>
<supervisor>0</supervisor>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<user>
<id>7</id>
</user>
</users>
<users> <!-- supervisor user -->
<admin>0</admin>
<member>1</member>
<primary>0</primary>
<supervisor>1</supervisor>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<user>
<id>8</id>
</user>
</users>
<users> <!-- admin user -->
<admin>1</admin>
<member>1</member>
<primary>0</primary>
<supervisor>0</supervisor>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<user>
<id>9</id>
</user>
</users>
</group>
</v3:createGroup>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createGroupResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>12</id>
<name>Nest group2</name>
<nonModifiable>false</nonModifiable>
<users>
<admin>false</admin>
<member>true</member>
<primary>false</primary>
<supervisor>false</supervisor>
<uniqueIdUnmodifiable>45</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<crmUserId/>
<customDateFormat/>
<customTimeFormat/>
<displayName>IPTUser1</displayName>
<eid>0000</eid>
<email/>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>6</id>
<language>en</language>
<locked>false</locked>
<loginName>IPTUser1</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>e10adc3949ba59abbe56e057f20f883e</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-15T12:16:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-23T15:14:59.317Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
<users>
<admin>false</admin>
<member>true</member>
<primary>false</primary>
<supervisor>false</supervisor>
<uniqueIdUnmodifiable>46</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<crmUserId/>
<customDateFormat/>
<customTimeFormat/>
<displayName>IPTUser2</displayName>
<eid>0000</eid>
<email>AbdulA@VerbaMsftTest.ccsctp.net</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>7</id>
<language>en</language>
<locked>false</locked>
<loginName>IPTUser2</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>e10adc3949ba59abbe56e057f20f883e</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-15T12:17:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-23T15:14:59.320Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
<users>
<admin>false</admin>
<member>true</member>
<primary>false</primary>
<supervisor>true</supervisor>
<uniqueIdUnmodifiable>47</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<crmUserId/>
<customDateFormat/>
<customTimeFormat/>
<displayName>TPO</displayName>
<eid>0000</eid>
<email>KatieJ@VerbaMsftTest.ccsctp.net</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>8</id>
<language>en</language>
<locked>false</locked>
<loginName>TPO</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>e10adc3949ba59abbe56e057f20f883e</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-15T12:17:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-23T15:14:59.323Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
<users>
<admin>true</admin>
<member>true</member>
<primary>false</primary>
<supervisor>false</supervisor>
<uniqueIdUnmodifiable>48</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<crmUserId/>
<customDateFormat/>
<customTimeFormat/>
<displayName>mate</displayName>
<eid>0000</eid>
<email/>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>9</id>
<language>en</language>
<locked>false</locked>
<loginName>mate</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>d87869a979db0078521d5872944e966e</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-10-12T15:47:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-23T15:14:59.323Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
</group>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:createGroupResponse>
</S:Body>
</S:Envelope>