住所の検索オプションを取得

以下は、住所APIを使用して希望する結果セットを取得するための使用例です。

この検索は、2010年11月1日以降に作成されたすべての会社の住所を返します。

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

この検索は、すべてのアクティブな会社の住所を返し、会社の住所のニックネームに「San Francisco」という単語が含まれている場合に返します。

https ://<instance url>/api/addresses? active = true&name [contains] =サン+フランシスコ

この検索は、米国とカリフォルニア州のすべての会社の住所を返します

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

この検索は、住所のニックネームに「Home Office」という単語が含まれているすべての個人住所を返します

https ://<instance url>/api/users/85/addresses? name =自宅+オフィス

住所の取得

この例では、IDが6の会社の住所レコードを検索しています。

以下のURLに対してGETリクエストを実行しました。

https ://<instance url>/api/addresses/6

または

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

<?xml version="1.0" encoding="UTF-8"?> <addresses type="array"> <address> <attention /> <city>サンフランシスコ</city> <id type="integer">14</id> <name>サンフランシスコオフィス</name> <postal-code>94450</postal-code> <state>CA</state> <street1>150メインストリート</street1> <street2 /> <country> <code>米国</code> <id type="integer">223</id> <name>米国</name> </country> </address> </addresses>

この例では、IDが85のユーザーのすべての個人住所レコードを検索しています。

以下のURLに対してGETリクエストを実行しました。

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

<?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>test 2</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>

住所の作成

この例では、会社の住所を作成しています。

https ://<instanceurl>/api/addresses.

<?xml version="1.0" encoding="UTF-8"?> <address> <name>シリコンバレー</name> <city>サンマテオ</city> <postal-code>94404</postal-code> <state>CA</state> <street1>2 W 5 th Ave</street1> <street2>Suite 300</street2> <country> <code>US</code> <name>アメリカ合衆国</name> </country> </address>

この例では、ユーザーIDが85のユーザーの個人住所を作成しています。

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 5 th Ave</street1> <street2 nil="true" /> <country> <code>US</code> <id type="integer">223</id> <name>アメリカ合衆国</name> </country> </address>

支払先住所の作成

この例では、特定のサプライヤーの支払先住所を作成しています

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>

住所の更新

以下の例では、会社の住所レコードを更新しています。

https ://<instance url>/api/addresses/<address ID>

たとえば、住所IDが「122」の住所レコードのニックネームと住所2を更新するには、以下を使用します。

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

<?xml version="1.0" encoding="UTF-8"?> <address> <name>サウスベイオフィス</name> <street2>スイート200</street2> </address>

たとえば、IDが122の会社の住所を無効にするには、以下のURLを使用します。

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

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

たとえば、ユーザーIDが「85」で住所IDが「125」の個人住所を無効にするには、以下を使用します。

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

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

サプライヤー支払先住所の更新

この例では、単一のサプライヤー支払先住所を更新しています。 支払先住所を更新する方法は、通常の住所と同様に容易ですが、サプライヤーと支払先IDの両方を知る必要があります

https ://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>

たとえば、支払先住所を更新して、IDが12のサプライヤーの支払先住所ID 23287の支払先コードを現在の値から「001」に修正するには、以下を使用します。

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>

たとえば、IDが「12」のサプライヤーの支払先住所ID「232887」を非アクティブ化にするには、以下を使用します。

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>