スクロール

Client - Read

Client Read Method

Client APIは、Client Resourceに対するアクセスを提供します。

Client Readでは、指定した検索条件に対応するClientのデータを取得することができます。

GET

https://{Request Host}/v1/client?partition=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&itemstate=[value]&keywords=[value,...]&order=[value,...]

 

Scope

Client Readを行うために必要なアクセス権は次の通りです。

client_r, user_r, option_r

 

Input Variables

GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。

また、指定できるParameterは以下の通りです。

Parameter間の条件はAND指定されたものとして検索されます。

必須 Parameter Definition
partition Partition Idを数値で指定します。
アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。
count 取得するデータの件数を数値で指定します。
指定できる値の範囲は、1~200までです。省略した場合は10が指定されたものとみなします。
start 取得するデータの開始インデックスです。0以上の値を数値で指定します。
field 出力する項目を指定します。省略した場合はClient.P_Idが指定されたものとみなします。
詳細は、Read API - Parameter > Read - Fieldを参照してください。
指定できるFieldは、Client - Field Listを参照してください。
condition 検索する条件を指定します。
詳細は、Read API - Parameter > Read - Conditionを参照してください。
指定できるFieldは、Client - Field Listを参照してください。

但し、itemstateにdeleted、または、allを指定する場合、conditionに指定できるFieldと条件は次の3種類です。
尚、次の3種類の条件を複数指定することは可能です。
 1.Client.P_Id
 2.Client.P_UpdateDate
   指定可能な値は、Request日時から90日前の同時刻までの間の値です。それ以前の日時を指定することはできません。
   省略した場合は、Request日時の90日前の同時刻が指定されたものとみなします。
 3.Client.P_UpdatedBy
itemstate 取得するデータの状態を指定します。
次の値を指定することができます。省略した場合は、existingが指定されたものとみなします。
 existing:削除されていないデータを取得
 deleted :削除されたデータを取得
 all        :すべての状態のデータを取得

※deletedまたはallを指定した場合、conditionに指定できる条件に制限が発生します。
※本Parameterは、2018/04/10より利用可能です。
keywords 取得するデータの条件をキーワードで指定します。
詳細は、Read API - Parameter > Read - Keywordsを参照してください。
order 出力時のデータの並び順を指定します。省略した場合は、Client.P_Id:ascが指定されたものとみなします。
詳細は、Read API - Parameter > Read - Orderを参照してください。
指定できるFieldは、Client - Field Listを参照してください。

 

Result Values

処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。

エラーが発生した場合は、200以外の値が返ります。

 

Output Values

出力値はXML形式で取得できます。

Tag Definition
Client 条件に該当するClientを含むルート要素です。
取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。
Clientの一つずつをItem要素として列挙します。
 Total Clientの属性。指定した検索条件で取得できる総件数を示します。
 Count Clientの属性。今回取得したデータの件数を示します。
 Start Clientの属性。今回取得したデータの開始インデックスを示します。
Code 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。
Item 一つのClient情報を表します。Field要素を持ちます。
 Field 指定された項目の値を格納します。
要素の名称は、Client - Field Listを参照してください。

 

Client Read Sample

※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。

次のサンプルは、Client Readで企業ID=100を条件として、企業IDと会社名を取得した場合の例です。

Input Parameter

https://{Request Host}/v1/client?partition=999999&field=Client.P_Id,Client.P_Name&condition=Client.P_Id:eq=100

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Client Total="1" Count="1" Start="0">
 <Code>0</Code>
 <Item>
  <Client.P_Id>100</Client.P_Id>
  <Client.P_Name>○×商事</Client.P_Name>
 </Item>
</Client>

 

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています