Client Write Method
Client APIは、Client Resourceに対するアクセスを提供します。
Client Writeでは、Clientを新規に登録、または更新することができます。
|
POST |
https://{Request Host}/v1/client?partition=[value] |
|---|
Scope
Client Writeを行うために必要なアクセス権は次の通りです。
client_w
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
次の値をXML形式でPOST時のデータブロックに指定できます。
| Tag | Definition |
|---|---|
| Client | Clientデータを表すルート要素です。 |
| Item | 一つのClient情報を表します。 |
| Field | 項目と値を指定します。指定できるFieldは、Client - Field Listを参照してください。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。
| Tag | Definition |
|---|---|
| Client | Clientデータを表すルート要素です。 |
| Item | 一つのClient情報を表します。 |
| Id | 更新または新規登録されたClientのIdです。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
Client Write Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、「AAA株式会社」を新規登録、企業ID：10022の電話番号を更新した場合の例です。
|
Input XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Client> <Item> |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |