User Object
OVERVIEW
XML format
<user>
<userid>102</userid>
<firstname>Tom</firstname>
<lastname>Chick</lastname>
<email>tom.chick@highq.com</email>
<emaildomain>1</emaildomain>
<org>1</org>
<img>
https://collabscrum14.hqdev.highq.com/collabscrum14/api/4/users/1687/avatar?size=256</img>
<title>Mr</title>
<goesby>vijay.odedra</goesby>
<invitationsent>29 May 2017 11:57</invitationsent>
<createdby>1</createdby>
<createddate>29 May 2017 10:10</createddate>
<modifiedby>102</modifiedby>
<modifieddate>29 May 2017</modifieddate>
<ifpartner>1</ifpartner>
<status>ACTIVE</status>
<lastlogindate>29 May 2017 05:08</lastlogindate>
<invalidlogins>7</invalidlogins>
<externalid>user_123213</externalid>
<publicwebsiteprofileid>1</publicwebsiteprofileid>
<systemuser>0</systemuser>
<phone>2341313</phone>
<secretaryname>abc</secretaryname>
<secretarymail>abc@yahoo.com</secretarymail>
<mobile>234234234</mobile>
<department>IT</department>
<resetpassworddate>29 May 2017 06:07</resetpassworddate>
<sourcetype>System</sourcetype>
<bio>asdf</bio>
<usertypeid>0</usertypeid>
<avatar>1</avatar>
<practicegroup>grp</practicegroup>
<langcode>en_GB</langcode>
<publicprofile>
http://blog.google.com/abc</publicprofile>
<jobtitle>Network Admin</jobtitle>
<specialities>CCNA</specialities>
<dateOfBirth>29 May 2017</dateOfBirth>
<!-- Address tag is available from V4. -->
<address>
<addressid>1</addressid>
<addressline1>2nd floor</addressline1>
<addressline2>additional</addressline2>
<city>london</city>
<state>state</state>
<country>uk</country>
<postCode>EC4R</postCode>
</address>
<!-- location tag is deprecated in V4 and replaced by address tag -->
<location>
<addressline1>2nd floor, 55 King William Street</addressline1>
<addressline2>additional</addressline2>
<addressline3>state</addressline3>
<city>London</city>
<country>United Kingdom</country>
<postcode>EC4R 9AD</postcode>
</location>
<sociallinks>
<link>
<name>LinkedIn</name>
<value>
https://linked.in/abc</value>
</link>
</sociallinks>
<messaginglink>
<link>
<name>Skype</name>
<value>abc</value>
</link>
</messaginglink>
<customlink>
<link>
<name>Myweb</name>
<value>
http://www.myiste.com</value>
</link>
</customlink>
</user>
JSON format
{
"userid": "102",
"firstname": "Tom",
"lastname": "Chick",
"email": "tom.chick@highq.com",
"emaildomain": "1",
"org": "1",
"img": "
https://collabscrum14.hqdev.highq.com/collabscrum14/api/4/users/1687/avatar?size=256
",
"title": "Mr",
"goesby": "vijay.odedra",
"invitationsent": "29 May 2017 11:57",
"createdby": "1",
"createddate": "29 May 2017 10:10",
"modifiedby": "102",
"modifieddate": "29 May 2017",
"ifpartner": "1",
"status": "ACTIVE",
"lastlogindate": "29 May 2017 05:08",
"invalidlogins": "7",
"externalid": "user_123213",
"publicwebsiteprofileid": "1",
"systemuser": "0",
"phone": "2341313",
"secretaryname": "abc",
"secretarymail": "abc@yahoo.com",
"mobile": "234234234",
"department": "IT",
"resetpassworddate": "29 May 2017 06:07",
"sourcetype": "System",
"bio": "asdf",
"usertypeid": "0",
"avatar": "1",
"practicegroup": "grp",
"langcode": "en_GB",
"publicprofile": "
http://blog.google.com/abc
",
"jobtitle": "Network Admin",
"specialities": "CCNA",
"dateOfBirth": "29 May 2017",
"address": {
"addressid": "1",
"addressline1": "2nd floor",
"addressline2": "additional",
"city": "london",
"state": "state",
"country": "uk",
"postCode": "EC4R"
},
"location": {
"addressline1": "2nd floor, 55 King William Street",
"addressline2": "additional",
"addressline3": "state",
"city": "London",
"country": "United Kingdom",
"postcode": "EC4R 9AD"
},
"sociallinks": {
"link": [
{
"name": "LinkedIn",
"value": "
https://linked.in/abc
"
},
{
"name": "blog",
"value": "
https://blog.com
"
}
]
},
"messaginglink": {
"link": [
{
"name": "Skype",
"value": "abc.com"
},
{
"name": "Skype",
"value": "abc.com"
}
]
},
"customlink": {
"link": [
{
"name": "MyWeb",
"value": "
http://www.mywebsite.com
"
},
{
"name": "MyWeb",
"value": "
http://www.mywebsite.com
"
}
]
}
}
Property |
Expected values ( Default value) |
Purpose |
Operation (READ, WRITE, UPDATE) |
userid | Integer | R | |
title | String | RWU | |
firstname | String | RWU | |
lastname | String | RWU | |
String | RWU | ||
emaildomain | Integer | Available from V4 | R |
org | Integer | RWU | |
img | String | Available from V4 | R |
goesby | String | RWU | |
address addressid | Integer | Available from V4 | RWU |
address addressline1 | String | Available from V4 | R |
address addressline2 | String | Available from V4 | R |
address city | String | Available from V4 | R |
address state | String | Available from V4 | R |
address country | String | Available from V4 | R |
address postcode | String | Available from V4 | R |
location addressline1 | String | location tag is deprecated in V4 and replaced by address tag | R |
location addressline2 | String | location tag is deprecated in V4 and replaced by address tag | R |
location addressline3 | String | location tag is deprecated in V4 and replaced by address tag | R |
location city | String | location tag is deprecated in V4 and replaced by address tag | R |
location country | String | location tag is deprecated in V4 and replaced by address tag | R |
location postcode | String | location tag is deprecated in V4 and replaced by address tag | R |
invitationsent | Date | Available from V4 | R |
createdby | Integer | Available from V4 | R |
createddate | Date | Available from V4 | R |
modifiedby | Integer | Available from V4 | R |
modifieddate | Date | Available from V4 | R |
ifpartner | Integer | Available from V4 | RWU |
status | String | This can be active, inactive or archive | RWU |
lastlogindate | Date | Available from V4 | R |
invalidlogins | Integer | Available from V4 | R |
jobtitle | String | RWU | |
externalid | String | Available from V4 | RWU |
publicwebsiteprofileid | String | Available from V4 | RWU |
systemuser | Integer | Available from V4 | RWU |
phone | String | RWU | |
secretaryname | String | RWU | |
secretarymail | String | RWU | |
mobile | String | RWU | |
department | String | RWU | |
resetpassworddate | Date | Available from V4 | R |
sourcetype | String | Available from V4. It can be System, Active Directory, System default | RWU |
bio | String | RWU | |
usertypeid | Integer | Available from V4 | RWU |
avatar | Integer | Store this in avatar column of user table in collaborate | R |
practicegroup | String | Available from V4 | RWU |
langcode | String | Available from V4. For example this can be en_GB, en_US etc | RWU |
publicprofile | String | Available from V4 | RWU |
specialities | String | RWU | |
dateOfBirth | Date | Available from V4 | RWU |
sociallinks link name | String | RWU | |
sociallinks link value | String | RWU | |
customlink link name | String | RWU | |
customlink link value | String | RWU | |
messaginglink link name | String | RWU | |
messaginglink link value | String | RWU |
Comments
0 Comments