Sociétés

Obtenir une liste de sociétés

GET /people/companies

Exemple de requête avec cURL

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

Exemple de réponse XML

HTTP Status: 200 OK
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<companies>
		<company>
		...
		</company>
		<company>
		...
		</company>
	</companies>
</xml>
	
Haut

Obtenir une société

GET /people/company/id/#{company_id}

Arguments de l'URI

Argument Type Requis Valeur
id integer oui Le #{company_id} de la société 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/company/id/1
	

Exemples de réponse XML

Lorsque #{company_id} est égal au #{company_id} de votre propre société :

HTTP Status: 200 OK
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<company>
		<company_id>1</company_id>
		<parent_company_id>0</parent_company_id><!-- toujours égal à 0 lorsqu'il s'agit de votre propre société -->
		<name>Company Name</name>
		<address>Address part 1</address>
		<address>Address part 2</address>
		<address>Address part 3</address>
		<address>Address part 4</address>
		<city>City</city>
		<state>State</state>
		<postalcode>012345</postalcode>
		<country>FR</country>
		<email>email@companyname.com</email>
		<phone>0134185483</phone>
		<fax>0134185483</fax>
		<webaddress>http://www.company.com</webaddress>
		<tax_id>FR12123123123</tax_id>
		<language>french</language>
		<is_tenant_account>1</is_tenant_account><!-- si égal à 1, indique qu'il s'agit de votre propre société -->
	</company>
</xml>	
	

Lorsque #{company_id} est égal au #{company_id} d'une société cliente :

HTTP Status: 200 OK
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<company>
		<company_id>2</company_id>
		<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 -->
		<name>Client Name</name>
		<address>Address part 1</address>
		<address>Address part 2</address>
		<address>Address part 3</address>
		<address>Address part 4</address>
		<city>City</city>
		<state>State</state>
		<postalcode>012345</postalcode>
		<country>FR</country>
		<email>email@clientname.com</email>
		<phone>0134185483</phone>
		<fax>0134185483</fax>
		<webaddress>http://www.company.com</webaddress>
		<tax_id>FR12123123123</tax_id>
		<language>french</language>
		<is_tenant_account>0</is_tenant_account><!-- si égal à 0, indique qu'il s'agit d'une société cliente -->
	</company>
</xml>
	
Haut

Créer une société

POST /people/company

Champs de la requête

Champ Type Requis Description
name string oui Nom
language string Langue. Voir les valeurs possibles de language.
tax_id string Numéro d'identification pour la taxe.
address1 string Ligne d'adresse 1.
address2 string Ligne d'adresse 2.
address3 string Ligne d'adresse 3.
address4 string Ligne d'adresse 4.
city string Ville
state string Etat/Région.
postalcode string Code postal.
country string Pays. Par défaut le pays de votre propre société. Voir les valeurs possibles de country.
phone string Ligne de téléphone.
fax string Ligne de fax.
email string Adresse e-mail.
webaddress string Adresse URL du site Internet.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "name=Nom de société&country=FR"\
https://#{subdomain}.iscriba.com/api/people/company
	

Exemple de réponse XML

HTTP Status: 201 Created
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<company_id>1</company_id>
</xml>	
	
Haut

Modifier une société

PUT /people/company/id/#{company_id}

Arguments de l'URI

Argument Type Requis Valeur
id integer oui Le #{company_id} de la société que vous souhaitez modifier.

Champs de la requête

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

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X PUT\
-d "country=GB"\
https://#{subdomain}.iscriba.com/api/people/company/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<company_id>1</company_id>
</xml>	
	
Haut

Supprimer une société

DELETE /people/company/id/#{company_id}

Arguments de l'URI

Argument Type Requis Valeur
id integer oui Le #{company_id} de la société 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/company/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK
<?xml version="1.0" encoding="utf-8"?>
<xml>
	<company_id>1</company_id>
</xml>	
	
Haut