APIのコール例に対処
このページは機械翻訳を使用して翻訳されています。
住所クエリオプションを取得
次に、address APIを使用してクエリを実行し、必要な結果セットを取得する方法の例をいくつか示します。
このクエリは、2010年11月1日以降に作成されたすべての会社住所を返します。
https://<instance url>/api/addresses?created_at[gt]=2010-11-01T00:00:00
このクエリはすべてのアクティブを返し、会社の住所のニックネームに「サンフランシスコ」という単語が含まれます。
https://<instance url>/api/addresses?active=true&name[contains]=San+Francisco
このクエリは、米国およびカリフォルニア州のすべての会社の住所を返します。
https://<instance url>/api/addresses?country[name]=United+States&state=CA
このクエリは、住所のニックネームに "Home Office"という単語が含まれるすべての個人住所を返します。
https://<instance url>/api/users/85/addresses?name=Home+Office
住所を取得
この例では、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>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>
この例では、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>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>
住所作成
この例では、会社の住所を作成しています。
<b id="i1"><a id="x1" xid="i25.1.1">URL []に</a></b>投稿しました。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>
この例では、ユーザーIDが85のユーザーの個人アドレスを作成しています。
<b id="i2"><a id="x2" xid="i27.1.1">URL []に</a></b>投稿します 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>
送金先住所の作成
この例では、特定のサプライヤーの送金先住所を作成しています。
<b id="i3"><a id="x3" xid="i30.1.1">URL []に</a></b>投稿しました。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>
住所の更新
これらの例では、単一の会社住所レコードを更新しています。
私たちは、URLにPUTをしました:https://<instance url>/api/addresses/<address ID>
たとえば、住所ID 122のニックネームと2行目で住所レコードを更新するには:
urlhttps://<instance url>/api/addresses/122
<?xml version="1.0" encoding="UTF-8"?> <address> <name>South Bay Office</name> <street2>Suite 200</street2> </address>
たとえば、ID 122の会社の住所を無効にするには:
urlhttps://<instance url>/api/addresses/122
<?xml version="1.0" encoding="UTF-8"?> <address> <active>false</active> </address>
たとえば、ユーザーID 85およびアドレスID 125の個人アドレスを無効にするには、次のように入力します。
urlhttps://<instance url>/api/users/85/addresses/125
<?xml version="1.0" encoding="UTF-8"?> <address> <active>false</active> </address>
サプライヤーの支払先住所の更新
これらの例では、単一のサプライヤー送金先住所を更新しています。送金先住所を更新する方法は、通常の住所と同じくらい簡単ですが、サプライヤーと送金先IDの両方を知る必要があります。
私たちは、URLにPUTをしました:https://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>
たとえば、ID 12のサプライヤーの送金先住所ID 23287の現在の値が「001」になっているものから、送金先住所を更新して送金先コードを修正するには
urlhttps://<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の送金先住所を無効にするには:
urlhttps://<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>