Site users management - Models - User object
OVERVIEW
The below XML defines the elements and attributes of a user object. These are the common attributes of a user in both Collaborate and Publisher.
<users>
<user>
<userid>102</userid>
<userlink>
https://localhost/R_4_1_4/api/2/users/102</userlink>
<httplink>
https://localhost/R_4_1_4/viewUserProfile.action?metaData.encryptTargetUserID=6nmQLN8jN8c=&metaData.updateUserProfileProcess=true</httplink>
<httpavatar>
https://localhost/R_4_1_4/downloadUserAvatar.action?user.userId=102&user.avatarWidth=48&user.lastModifiedTime=0</httpavatar>
<avatar>
https://localhost/R_4_1_4/api/2/users/102/avatar?size=48&lastmodifieddate=1495787935207</avatar>
<name>
<firstname>user</firstname>
<lastname>name</lastname>
<goesby></goesby>
<title></title>
</name>
<externalid></externalid> {Optional element used when the user is being imported / linked from an external system}
<email>user@domain.com</email>
<phone>44156680000</phone>
<jobtitle>Senior Solution Architect</jobtitle>
<mobile>441561510000</mobile>
<department>Development</department>
<status>active</status>
<organisation>
<orgname></orgname>
<orgid></orgid> {GUID ID of the organisation}
<orgaddressid></orgaddressid>
</organisation> {Not present in Collaborate, what to do in that case, also please note that we should have an organisation API to return the organisation details by giving the organisation name}
<location>
<addressline1>New London House</addressline1>
<addressline2>6 London Street</addressline2>
<city>London</city>
<country>United Kingdom</country>
<postCode>EC3R 7LP</postCode>
</location>
<The below elements are only present in Collaborate >
<img>
http://blog.newrelic.com/wp-content/uploads/java-logo.jpg</img>
<sociallinks>
<link>
<name>LinkedIn</name>
<value>
http://www.linkin.com/tom.chick</value>
</link>
</sociallinks>
<customlink>
<link>
<name>My Web</name>
<value>
http://www.mywebsite.com</value>
</link>
</customlink>
<messaginglink>
<link>
<name>Skype</name>
<value>tom.chick.skype</value>
</link>
</messaginglink>
<secretaryname>time of india</secretaryname>
<secretarymail>times@india.com</secretarymail>
<bio>Development manager</bio>
<sourcetype>AD</sourcetype>
<specialities>java,dotNet</specialities>
</user>
</users>
Parameter | Type | Description |
---|---|---|
firstname | String | |
lastname | String | |
userid | String | unique identity id |
userlink | String | API link for user profile |
httplink | String | http link for user profile |
httpavatar | String | http link for user avatar |
avatar | API link for user avatar | |
Organisation | Object | This is a object of organisation details where organisation ID is the GUID of the organisation, and Organisation address ID is the GUID For the organisation address ID |
String | ||
phone | String | |
mobile | String | |
department | String | |
org | String | |
location location object composed of the following string variables String addressline1 <location> <addressline1 /> </location> |
Object | |
experiences a list of string objects of name "experience" <experiences type="list"> <experience></experience> <experience></experience> </experiences> |
list of string objects | |
sociallinks <sociallinks type="list"> <social name="linkedIn" value="http://linkedin.com/joeblow" />
<social name="twitter" value="http://twitter.com/joeblow" />
</sociallinks> |
list of name / value pair | |
messaginglink | list of name / value pair | |
customlink | list of name / value pair | |
img | String | |
reportsto | String | |
metadata <metadatalist type="list">
<metadata name="awards" value="employee of the month" />
<metadata name="sports" value="golf" />
</metadatalist>
|
A list of name / value pairs | |
groups <groups type="list">
<group>GRP001</groups>
<group> GRP002</groups>
</groups>
|
a list of groups | |
jobtitle | String | |
secretaryname | String | |
secretarymail | String | |
specialities | String | |
title | String | |
goesby | String | |
suffix | String | |
atomlink | String | |
bio | String | |
dateOfBirth | String | |
link | String | |
status | String | |
sourcetype | String |
Comments
0 Comments