Add user - Add user v1 | Thomson Reuters Developer Portal

User resource

Add user - Add user v1

OVERVIEW

Adds a new user to Collaborate. The user is added at the system level. Add user requires the user object to be sent in the body of the request. The response provides the user id, email and the URL to that user in Collaborate.
Note: We do not support adding and updating location information in the User API, only the get operation returns location information.

Request

POST /users

Request XML

<user>
<firstname>user</firstname>
<lastname>name</lastname>
<email>user@domain.com</email>
<phone>44156680000</phone>
<mobile>441561510000</mobile>
<department>Development</department>

<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>
<jobtitle>Senior Solution Architect</jobtitle>

<secretaryname>time of india</secretaryname>
<secretarymail>times@india.com</secretarymail>
<title>Mr</title>
<bio>Development manager</bio>
<sourcetype>AD</sourcetype>

<specialities>java,dotNet</specialities>
<status>active</status>
<goesby>alpesh.lodhari</goesby>
</user>

Parameter	Type	Description
firstname	String
lastname	String
email	String
phone	String
mobile	String
department	String
org	String
location location object compose of the following string variables String addressline1 String addressline2 String addressline3 String city String state String country String postCode <location> <addressline1 /> <addressline2 /> <addressline3 /> <city /> <state /> <country /> <postCode /> </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	status is a mandatory field & valid value is active or archive
sourcetype	String	Sourcetype is a mandatory field

Response

<user>

<email> joe@domain.com </email>

<atom:link rel="self" href="…/users/USR003" />

</user>

Error Response

In case of an error the system throws an error object

<error>

<ref> Error reference code in at which full stack trace can be obtained</ref>

<summery> Details for the error </summery>

</error>

Message with response code=500, will include all kind of error/validation messages such as first name required, organisation does not exist, domain does not exist, invalid email address, any other internal error etc.

Comments

0 Comments

Last Updated: Nov 08,2024