Exemples d'appels API

Options de requête d'adresse 

Voici d'autres exemples d'utilisation de l'API d'adresse pour interroger et obtenir le jeu de résultats souhaité.

Cette requête renverra toutes les adresses de société créées après la date du 1er novembre 2010.

https://<instance url>/api/addresses?created_at[gt]=2010-11-01T00:00:00

Cette requête retournera toutes les adresses actives et où le surnom des adresses de la société contient les mots "San Francisco".

https://<instance url>/api/addresses?active=true&name[contains]=San+Francisco

Cette requête renverra toutes les adresses de sociétés aux États-Unis et dans l'État de Californie

https://<instance url>/api/addresses?country[name]=United+States&state=CA

Cette requête retournera toutes les adresses personnelles où le surnom de l'adresse contient le mot "Home Office"

https://<instance url>/api/users/85/addresses?name=Home+Office

Obtenir une adresse

Dans cet exemple, nous avons recherché un enregistrement d'adresse d'entreprise avec un ID de 6.

Nous avons accédé à l'URL : 

https://<instance url>/api/addresses/6
ou
https://<instance url>/api/addresses?id=6

Voici la réponse correspondant aux critères de recherche :

<?xml version="1.0" encoding="UTF-8"?>
<addresses type="array">
	 <address>
			<attention />
			<city>San Francisco</city>
			<id type="integer">14</id>
			<name>San Francisco Office</name>
			<postal-code>94450</postal-code>
			<state>CA</state>
			<street1>150 Main Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
</addresses>

Dans cet exemple, nous avons recherché tous les enregistrements d'adresse personnelle de l'utilisateur avec un ID de 85.

Nous avons accédé à l'URL :
https://<instance url>/api/users/85/addresses

Voici la réponse correspondant aux critères de recherche :

<?xml version="1.0" encoding="UTF-8"?>
<addresses type="array">
	 <address>
			<attention>Margret Patrick</attention>
			<city>San Mateo</city>
			<id type="integer">123</id>
			<name>Home Office</name>
			<postal-code>94402</postal-code>
			<state>CA</state>
			<street1>111 Main Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
	 <address>
			<attention>Margret Patrick</attention>
			<city>San Francisco</city>
			<id type="integer">124</id>
			<name>test2</name>
			<postal-code>94103</postal-code>
			<state>CA</state>
			<street1>2600 Polk Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
</addresses>

Créer une adresse

Dans cet exemple, nous créons une adresse d'entreprise.

Nous l'avons posté sur l'URL  https://<instance url>/api/addresses.

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <name>Silicon Valley</name>
	 <city>San Mateo</city>
	 <postal-code>94404</postal-code>
	 <state>CA</state>
	 <street1>2 W 5th Ave</street1>
	 <street2>Suite 300</street2>
	 <country>
			<code>US</code>
			<name>United States</name>
	 </country>
</address>

Dans cet exemple, nous créons une adresse personnelle pour l'utilisateur avec l'ID utilisateur 85.

Nous le publions sur l'URL https://<instance url>/api/users/85/addresses

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <attention nil="true" />
	 <city>San Mateo</city>
	 <id type="integer">125</id>
	 <name>Silicon Valley</name>
	 <postal-code>94400</postal-code>
	 <state>CA</state>
	 <street1>2 W 5th Ave</street1>
	 <street2 nil="true" />
	 <country>
			<code>US</code>
			<id type="integer">223</id>
			<name>United States</name>
	 </country>
</address>

Créer une adresse de paiement

Dans cet exemple, nous créons une adresse de paiement pour un fournisseur spécifique

Nous l'avons posté sur l'URL https://<instance url>/api/suppliers/<supplier id>/addresses

<?xml version="1.0" encoding="UTF-8"?>
<remit-to-address>
	 <remit-to-code>100</remit-to-code>
	 <name>100 Ellsworth</name>
	 <street1>100 Ellsworth Ave.</street1>
	 <city>SAN MATEO</city>
	 <state>CA</state>
	 <postal-code>94404</postal-code>
	 <active type="boolean">true</active>
	 <country>
			<code>US</code>
	 </country>
</remit-to-address>

Mise à jour adresse

Dans ces exemples, nous mettons à jour un enregistrement d'adresse d'entreprise unique.

Nous avons effectué un PUT vers l'URL : https://<instance url>/api/addresses/<address ID>

Par exemple, pour mettre à jour l'enregistrement d'adresse avec un surnom et la ligne 2 pour l'ID d'adresse 122 :

URL :  https://<instance url>/api/addresses/122

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <name>South Bay Office</name>
	 <street2>Suite 200</street2>
</address>

Par exemple, pour désactiver une adresse de société avec ID 122 : 

URL :  https://<instance url>/api/addresses/122

 <?xml version="1.0" encoding="UTF-8"?>
<address>
	 <active>false</active>
</address>

Par exemple, pour désactiver une adresse personnelle pour les ID utilisateur 85 et 125 : 

URL :  https://<instance url>/api/users/85/addresses/125

 <?xml version="1.0" encoding="UTF-8"?>
<address>
	 <active>false</active>
</address>

Mise à jour des adresses de paiement des fournisseurs

Dans ces exemples, nous mettons à jour une adresse de paiement fournisseur unique. Pour mettre à jour l'adresse de paiement, tout en étant aussi simple que l'adresse standard, il faut connaître à la fois le fournisseur et l'ID de paiement

Nous avons effectué un PUT vers l'URL : https://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>

Par exemple, pour mettre à jour l'adresse de paiement afin de fixer le code de paiement de la valeur actuelle à "001" pour l'adresse de paiement ID 23287 pour le fournisseur avec ID 12

URL :  https://<instance url>/api/suppliers/12/remit_to_addresses/23287

<?xml version="1.0" encoding="UTF-8"?>
<remit-to-address>
	 <remit-to-code>001</remit-to-code>
</remit-to-address>

Par exemple, pour désactiver une adresse de paiement avec ID 232887 pour le fournisseur avec ID 12 :

URL :  https://<instance url>/api/suppliers/12/remit_to_addresses/23287 

<?xml version="1.0" encoding="UTF-8"?>
<remit-to-address>
	 <remit-to-code>001</remit-to-code>
	 <active>false</active>
</remit-to-address>