Adressen-API-Beispielaufrufe
Abfrageoptionen für Adresse abrufen
Hier sind einige weitere Beispiele, wie Sie die Adress-API zum Abfragen und Abrufen des gewünschten Ergebnissatzes verwenden können.
Diese Abfrage gibt alle Unternehmensadressen zurück, die nach dem Datum, dem 1. November 2010, erstellt wurden.
https://<instance url>/api/addresses?created_at[gt]=2010-11-01T00:00:00
Diese Abfrage gibt alle aktiven zurück, bei denen der Spitzname der Firmenadressen die Wörter "San Francisco" enthält.
https://<instance url>/api/addresses?active=true&name[enthält]=San+Francisco
Diese Abfrage gibt alle Unternehmensadressen in den Vereinigten Staaten und im Bundesstaat Kalifornien zurück
https://<instance url>/api/addresses?country[name]=Vereinigte Staaten&state=CA
Diese Abfrage gibt alle persönlichen Adressen zurück, bei denen der Spitzname der Adresse das Wort "Home Office" enthält.
https://<instance url>/api/users/85/addresses?name=Heim+Büro
Adresse abrufen
In diesem Beispiel haben wir nach einem Firmenadressdatensatz mit der ID 6 abgefragt.
Wir sind zur URL gelangt:
https://<instance url>/api/addresses/6
oder
https://<instance url>/api/addresses?id=6
Hier ist die Antwort, die den Suchkriterien entspricht:
<?xml version="1.0" encoding="UTF-8"?>
<addresses type="array">
<address>
<attention />
<city>San Francisco</city>
<id type="integer">14</id>
<name>San Francisco Büro</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>Vereinigte Staaten</name>
</country>
</address>
</addresses>In diesem Beispiel haben wir alle persönlichen Adressdatensätze für Benutzer mit der ID 85 abgefragt.
Wir sind zur URL GEKOMMEN:
https://<instance url>/api/users/85/addresses
Hier ist die Antwort, die den Suchkriterien entspricht:
<?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>Homeoffice</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>Vereinigte Staaten</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>Vereinigte Staaten</name>
</country>
</address>
</addresses>Adresse erstellen
In diesem Beispiel erstellen wir eine Firmenadresse.
Wir haben es unter der URL https://<instance url>/api/addresses gepostet.
<?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>Vereinigte Staaten</name>
</country>
</address>In diesem Beispiel erstellen wir eine persönliche Adresse für den Benutzer mit der Benutzer-ID 85.
Wir posten es unter der 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>Vereinigte Staaten</name>
</country>
</address>Zahlungsempfängeradresse erstellen
In diesem Beispiel erstellen wir eine Zahlungsempfängeradresse für einen bestimmten Lieferanten
Wir haben es unter der URL https://<instance url>/api/suppliers/<supplier id>/addresses gepostet
<?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">wahr</active>
<country>
<code>US</code>
</country>
</remit-to-address>Adressaktualisierung
In diesen Beispielen aktualisieren wir einen einzelnen Firmenadressdatensatz.
Wir haben einen PUT auf die URL: https://<instance url>/api/addresses/<address ID>
So aktualisieren Sie beispielsweise den Adresseintrag mit einem Spitznamen und Zeile 2 für die Adress-ID 122:
URL: https://<instance url>/api/addresses/122
<?xml version="1.0" encoding="UTF-8"?>
<address>
Büro <name>in South Bay</name>
<street2>Suite 200</street2>
</address>So deaktivieren Sie beispielsweise eine Firmenadresse mit der ID 122:
URL: https://<instance url>/api/addresses/122
<?xml version="1.0" encoding="UTF-8"?>
<address>
<active>false</active>
</address>So deaktivieren Sie beispielsweise eine persönliche Adresse für die Benutzer-ID 85 und die Adress-ID 125:
URL: https://<instance url>/api/users/85/addresses/125
<?xml version="1.0" encoding="UTF-8"?>
<address>
<active>false</active>
</address>Lieferanten-Zahlungsempfänger-Adressaktualisierung
In diesen Beispielen aktualisieren wir eine einzelne Zahlungsadresse des Lieferanten. Die Art und Weise, wie die REMIT-TO-Adresse aktualisiert wird, ist zwar genauso einfach wie die reguläre Adresse, erfordert jedoch die Kenntnis des Lieferanten und der REMIT-TO-ID
Wir haben einen PUT auf die URL: https://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>
Zum Beispiel, um die Zahlungsempfängeradresse zu aktualisieren, um den Zahlungsempfängercode von dem aktuellen Wert auf "001" für die Zahlungsempfängeradressen-ID 23287 für Lieferanten mit ID 12 zu ändern
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>So deaktivieren Sie beispielsweise eine REMIT-TO-Adresse mit der ID 232887 für Lieferanten mit der 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>