• 最終編集日時: 12 February 2020

APIの呼び出しの例に対処する

住所クエリオプションの取得 

ここでは、アドレスAPIを使用してクエリを実行し、必要な結果セットを取得する方法の例をいくつか紹介します。

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

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

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

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

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

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

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

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

住所を取得

この例では、IDが6の会社の住所レコードを照会しました。

URLへのアクセスを行いました。 

https :///api<instance url>/addresses/6
または
https :///api<instance url>/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>カナダ</state>

			メインストリート<street1>150番地</street1>

			<street2 />

			<country>

				 <code>US</code>

				 <id type="integer">223</id>

				 <name>米国</name>

			</country>

	 </address>

</addresses>

この例では、IDが85のユーザーの個人的な住所レコードをすべて照会しました。

次のURLにアクセスしました:
https ://<instance url>/api/users/85/addresses

検索条件に一致する回答は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>

<addresses type="array">

	 <address>

			<attention>MARGRET PATRICK氏</attention>

			<city>サンマテオ</city>

			<id type="integer">123</id>

			<name>ホームオフィス</name>

			<postal-code>94402</postal-code>

			<state>カナダ</state>

			<street1>111メインストリート</street1>

			<street2 />

			<country>

				 <code>米国</code>

				 <id type="integer">223</id>

				 <name>米国</name>

			</country>

	 </address>

	 <address>

			<attention>MARGRET PATRICK氏</attention>

			<city>サンフランシスコ</city>

			<id type="integer">124</id>

			<name>test 2</name>

			<postal-code>94103</postal-code>

			<state>カナダ</state>

			<street1>2600 Polk Street</street1>

			<street2 />

			<country>

				 <code>米国</code>

				 <id type="integer">223</id>

				 <name>米国</name>

			</country>

	 </address>

</addresses>

住所の作成

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

URL https :///api<instance url>/addressesに投稿しました。

<?xml version="1.0" encoding="UTF-8"?>

<address>

	 <name>Silicon Valley</name>

	 <city>サンマテオ</city>

	 <postal-code>94404</postal-code>

	 <state>カナダ</state>

	 <street1>2 W 5 th Ave</street1>

	 <street2>スイート300</street2>

	 <country>

			<code>US</code>

			<name>米国</name>

	 </country>

</address>

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

Https :///api/users/85<instance url>/addressesに投稿します

<?xml version="1.0" encoding="UTF-8"?>

<address>

	 <attention nil="true" />

	 <city>サンマテオ</city>

	 <id type="integer">125</id>

	 <name>Silicon Valley</name>

	 <postal-code>94400</postal-code>

	 <state>カナダ</state>

	 <street1>2 W 5 th Ave</street1>

	 <street2 nil="true" />

	 <country>

			<code>米国</code>

			<id type="integer">223</id>

			<name>米国</name>

	 </country>

</address>

支払先住所作成

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

URL https :///api/suppliers<instance url><supplier id> // addressesに投稿しました

<?xml version="1.0" encoding="UTF-8"?>

<remit-to-address>

	 <remit-to-code>100</remit-to-code>

	 <name>100エルスワース</name>

	 <street1>100 Ellsworth Ave.</street1>

	 <city>サンマテオ</city>

	 <state>カナダ</state>

	 <postal-code>94404</postal-code>

	 <active type="boolean">true</active>

	 <country>

			<code>US</code>

	 </country>

</remit-to-address>

住所の更新

これらの例では、1つの会社の住所レコードを更新しています。

次のURLに置きました: https ://<instance url>/api/addresses/<address ID>

たとえば、住所ID 122のニックネームと2行目で住所レコードを更新するには:

URL:  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>偽</active>

</address>

例えば、ユーザID 8 5及びアドレスID 1 2 5の個人の住所を無効にするには、 

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

 <?xml version="1.0" encoding="UTF-8"?>

<address>

	 <active>偽</active>

</address>

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

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

次のURLに置きました: https ://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>

たとえば、支払先住所を更新して、ID 12のサプライヤーの支払先住所ID 23287の支払先コードを現在の値から「001」に固定するには

URL:  https :///api<instance url>/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の支払先住所を無効にするには:

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

<?xml version="1.0" encoding="UTF-8"?>

<remit-to-address>

	 <remit-to-code>001</remit-to-code>

	 <active>偽</active>

</remit-to-address>

 

  • Inhalt