Personnes

Obtenir une liste de personnes

GET /people/users[/id/#{company_id}]

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer		Le #{company_id} de la société pour laquelle vous souhaitez obtenir les personnes.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/people/users
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<users>
		<user>
		...
		</user>
		<user>
		...
		</user>
	</users>
</xml>
	

Note : les données présentes dans les noeuds <item> sont différentes selon que la personne est liée à votre propre société ou à une société cliente. Consultez obtenir une personne pour voir les différentes possibilités.

Haut

---

Obtenir une personne

GET /people/user/id/#{user_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{user_id} de la personne que vous souhaitez obtenir.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/people/user/id/1
	

Exemples de réponse XML

Lorsque #{user_id} est égal au #{user_id} d'une personne liée à votre propre société :

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<user>
		<user_id>1</user_id>
		<company_id>1</company_id>
		<company_name>Company Name</company_name>
		<parent_company_id>0</parent_company_id><!-- toujours égal à 0 lorsqu'il s'agit de votre propre société -->
		<firstname>Firstname</firstname>
		<lastname>Lastname</lastname>
		<email>firstname@companyname.com</email>		
		<username>username</username>
		<other_infos>
		    <title>Title</title>
		    <officephone>0123456789</officephone>
		    <officephone_ext>123</officephone_ext>
		    <mobilephone>0612345678</mobilephone>
		    <fax>0123456789</fax>
		    <homephone>0123456789</homephone>
		    <imname>IM Name</imname>
		    <imservice>AIM</imservice>
		</other_infos>
		<language>french</language>
		<show_help>1</show_help>
		<is_account_owner>1</is_account_owner>
		<is_admin>1</is_admin>
		<feeds_token>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</feeds_token>
	</user>
</xml>	
	

Lorsque #{user_id} est égal au #{user_id} d'une personne liée à une société cliente :

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<user>
		<user_id>4</user_id>
		<company_id>2</company_id>
		<company_name>Client Name</company_name>
		<parent_company_id>1</parent_company_id><!-- toujours égal au #{company_id} de votre propre société lorsqu'il s'agit d'une société cliente -->
		<firstname>Firstname</firstname>
		<lastname>Lastname</lastname>
		<email>firstname@clientname.com</email>		
		<other_infos>
		    <title>Title</title>
		    <officephone>0123456789</officephone>
		    <officephone_ext>123</officephone_ext>
		    <mobilephone>0612345678</mobilephone>
		    <fax>0123456789</fax>
		    <homephone>0123456789</homephone>
		    <imname>IM Name</imname>
		    <imservice>AIM</imservice>
		</other_infos>
		<language>french</language>
		<show_help>1</show_help>
		<is_favorite>1</is_favorite>
		<auth_token>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</auth_token>
		<feeds_token>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</feeds_token>
	</user>
</xml>	
	

Haut

---

Créer une personne

POST /people/user

Champs de la requête

Champ	Type	Requis	Valeur
Champs communs à toutes les personnes :
company_id	integer	oui	#{company_id} de la société à laquelle lier cette personne.
firstname	string	oui	Prénom.
lastname	string	oui	Nom.
email	string	oui	Adresse e-mail.
language	string	oui	Langue. Voir les valeurs possibles de language.
title	string		Titre (position dans la société).
officephone	string		Ligne de téléphone professionnelle.
officephone_ext	string		Extension pour la ligne de téléphone professionnelle.
mobilephone	string		Ligne de téléphone mobile.
fax	string		Ligne de fax.
homephone	string		Ligne de téléphone personnelle.
imname	string		Nom d'utilisateur pour un service de messagerie instantanée.
imservice	string		Service de messagerie instantanée. Voir les valeurs possibles de imservice.
show_help	boolean		Activer/désactiver l'aide contextuelle dans l'interface.
Champs pour une personne liée à votre société :
username	string	oui	Nom d'utilisateur.
password	string	oui	Mot de passe.
is_admin	boolean		Détermine si la personne à le statut administrateur.
Champs pour une personne liée a une société cliente :
is_favorite	boolean		Détermine si la personne est un interlocuteur favori.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "company_id=1&firstname=John&lastname=Doe&email=johndoe@domaine.com&language=french"\
https://#{subdomain}.iscriba.com/api/people/user
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<user_id>1</user_id>
</xml>	
	

Haut

---

Modifier une personne

PUT /people/user/id/#{user_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{user_id} de la personne que vous souhaitez modifier.

Champs de la requête

Identiques à créer une personne excepté qu'aucun champ n'est requis.

Note : les mises à jour de mot de passe ou de nom d'utilisateur ne sont pas effectuées et vous ne pouvez pas déplacer un utilisateur.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X PUT\
-d "firsname=Jane&language=english"\
https://#{subdomain}.iscriba.com/api/people/user/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<user_id>1</user_id>
</xml>	
	

Haut

---

Supprimer une personne

DELETE /people/user/id/#{user_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{user_id} de la personne que vous souhaitez supprimer.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X DELETE https://#{subdomain}.iscriba.com/api/people/user/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<user_id>1</user_id>
</xml>	
	

Haut

---