Skip to end of metadata
Go to start of metadata

Overview

Reads a Group.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
nameStringThe name of theMandatory
environmentStringThe environmentMandatory
environmentParamIsShortNamebooleanIf true the environment parameter is a short name otherwise it's an eidMandatory

Response

Parameters of the API response in GetGroupByNameAndEnvironment type called return:

ParameterType

Description

statusStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
groupGroup

Examples


 Example GetGroupByNameAndEnvironment transaction.
Example GetGroupByNameAndEnvironment 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:getGroupByNameAndEnvironment>
         <token>xjK9AVj1Lc4ciA4tBxEelKBrC5astJYj</token>
         <name>Default</name>
         <environment>0000</environment>
         <environmentParamIsShortName>0</environmentParamIsShortName>
      </v3:getGroupByNameAndEnvironment>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getGroupByNameAndEnvironmentResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <group>
               <eid>0000</eid>
               <environmentShortName>Ref.</environmentShortName>
               <id>1</id>
               <name>Default</name>
               <nonModifiable>false</nonModifiable>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>1</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Verba Administrator</displayName>
                     <eid>0000</eid>
                     <email/>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>1</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>Administrator</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2014-08-28T07:42:37.193Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-08-28T07:42:37.287Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>2</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>true</apiAccessOnly>
                     <displayName>Verba Desktop Api User</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>2</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>verbadesktopapi</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-08-28T07:43:45.493Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-08-28T07:43:45.493Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>false</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>3</uniqueIdUnmodifiable>
                  <user>
                     <agentId/>
                     <apiAccessOnly>false</apiAccessOnly>
                     <crmUserId/>
                     <customDateFormat/>
                     <customTimeFormat/>
                     <displayName>olibali</displayName>
                     <eid>0000</eid>
                     <email/>
                     <environmentShortName>Ref.</environmentShortName>
                     <externalId/>
                     <id>3</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>olibali</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-08-28T09:17:00Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-08-28T09:17:00Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>11</uniqueIdUnmodifiable>
                  <user>
                     <agentId/>
                     <apiAccessOnly>true</apiAccessOnly>
                     <crmUserId/>
                     <customDateFormat/>
                     <customTimeFormat/>
                     <displayName>verba_api_user</displayName>
                     <eid>0000</eid>
                     <email/>
                     <environmentShortName>Ref.</environmentShortName>
                     <externalId/>
                     <id>11</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>verba_api_user</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T12:01:00Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T12:01:00Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>19</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Ken Willoughby</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>19</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>ken</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>20</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Kovats Gergely</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>20</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>kovats</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>21</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Bálint Kuhár</displayName>
                     <eid>0000</eid>
                     <email>kuhar@verba.com</email>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>21</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>kuhar</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>22</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Lori Peterson</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>22</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>lori</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>23</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Moczar Gabor</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>23</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>moczar</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>24</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Kakas Norbert</displayName>
                     <eid>0000</eid>
                     <email>kakas@verba.com</email>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>24</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>norbi</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
               <users>
                  <admin>false</admin>
                  <member>true</member>
                  <primary>true</primary>
                  <supervisor>false</supervisor>
                  <uniqueIdUnmodifiable>25</uniqueIdUnmodifiable>
                  <user>
                     <apiAccessOnly>false</apiAccessOnly>
                     <displayName>Krasznai Péter</displayName>
                     <eid>0000</eid>
                     <environmentShortName>Ref.</environmentShortName>
                     <id>25</id>
                     <language>en</language>
                     <locked>false</locked>
                     <loginName>peti</loginName>
                     <needChangePassword>false</needChangePassword>
                     <nonModifiable>false</nonModifiable>
                     <passwordExpires>false</passwordExpires>
                     <passwordHash>.........................</passwordHash>
                     <timeZone>Europe/Budapest</timeZone>
                     <userType>user_type_verba</userType>
                     <validFrom>2015-11-19T14:35:26.310Z</validFrom>
                     <validTo>2099-12-31T00:00:00Z</validTo>
                  </user>
                  <validFromUnmodifiable>2015-11-19T14:35:26.310Z</validFromUnmodifiable>
                  <validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
               </users>
            </group>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:getGroupByNameAndEnvironmentResponse>
   </S:Body>
</S:Envelope>