User resource

Site users management - Models - User summary object for get all site/system users API

OVERVIEW

The below XML defines the elements and attributes of a user object. Please note that this object does not cover all user attributes but only the attributes that are commonly used. The user summary object is returned in the case of list functions such as get user list to avoid sending all user details.  The complete user details can be obtained by calling GetUserInfo method. 


<users>
<user>

       <userid>102</userid>        <!--Used in both Site level and System level users object -->
        <name>             <!--Used in both Site level and System level users object -->
            <firstname>Tom</firstname>
            <lastname>Chick</lastname>
        </name>
        <email>tom.chick@highq.com</email>       <!--Used in both Site level and System level users object -->
        <phone></phone>      <!--Used in only Site level users object -->
        <jobtitle></jobtitle>      <!--Used in only Site level users object -->
        <mobile></mobile>      <!--Used in only Site level users object -->
        <department></department>      <!--Used in only Site level users object -->
        <status>Active</status>         <!--Used in both Site level and System level users object -->
        <organisation> 
            <orgname>HighQ</orgname>   <!--Used in both Site level and System level users object -->
            <orgid>1</orgid>  <!--Used in both Site level and System level users object -->
            <orgaddress>2nd floor, 55 King William Street,,London,,United Kingdom,EC4R 9AD,+44 20 7220 5340</orgaddress>       <!--Used in only Site level users object -->
        </organisation>
        <location>      <!--Used in only Site level users object -->
            <city>London</city>
        </location>
        <invited>11 Sep 2017 07:30</invited>      <!--Used in only Site level users object -->
        <lastlogin>09 Nov 2017 09:03</lastlogin>      <!--Used in only Site level users object -->
        <role>System admin</role>      <!--Used in only Site level users object -->
    </user>
</users>

 

Parameter Type Description
userid Integer ID of the User
firstname     String Firstname of the User
lastname     String Lastname of the User
organisation Object This is a object of organisation details where orgid is the GUID of the organisation, and orgaddress is the organisation address.orgname is the organisation name.
email    String Email of the user
phone    String Phone number
mobile     String Mobile number
department     String Department of the user

location

location object compose of the following string variables

    String city
   <location>  
    <city />  

</location>

 Object City from where the user belongs
jobtitle     String Job title of the User
status    String Status of the participant user in the site i.e Active or Suspended
invited String Invitation date and time
lastlogin String Last login date and time
role String Role of the user in the site i.e system admin, site admin, member admin, content admin, reporting admin, QA admin.

Comments


0 Comments

Last Updated: Nov 08,2024