スクロール

Partition - Read

Partition Read Method

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

Partition Readでは、指定した条件に対応するPartitionのリストを取得することができます。

GET

https://{Request Host}/v1/partition?request_type=[value]&count=[value]&start=[value]

 

Scope

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

partition_r

 

Input Variables

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

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

必須 Parameter Description
request_type 取得するPartitionのタイプを指定します。
アプリ登録されている種別によって指定できるタイプが異なります。次の値を指定することができます。
 0:現在、同じブラウザ上でLoginしているPartitionの情報が取得できます。
 1:現在のAccess Tokenでアクセス可能なPartitionのリストを取得できます。
count 取得するデータの件数を数値で指定します。
指定できる値の範囲は、1~200までです。省略した場合は10が指定されたものとみなします。
start 取得するデータの開始インデックスです。
0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。

 

Result Values

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

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

 

Output Values

出力値はXML形式で取得できます。Partition APIで取扱可能な任意のFieldはありません。

Tag Description
Partition 条件に該当するPartitionを含むルート要素です。
取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。
 Total Partitionの属性。指定した検索条件で取得できる総件数を示します。
 Count Partitionの属性。今回取得したデータの件数を示します。
 Start Partitionの属性。今回取得したデータの開始インデックスを示します。
Code 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。
Item 一つのPartition情報を表します。
 Partition.P_Id PartitionのIdです。
 Partition.P_Name HRBC契約企業の会社名です。
 Partition.P_CompanyId HRBC業務画面へのログイン時に利用する会社IDです。

 

Partition Read Sample

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

次のサンプルは、現在のAccess Tokenでアクセス可能なPartitionを取得した場合の例です。

Input Parameter

https://{Request Host}/v1/partition?request_type=0&count=1&start=0

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Partition Total="1" Count="1" Start="0">
 <Code>0</Code>
 <Item>
  <Partition.P_Id>999999</Partition.P_Id>
  <Partition.P_Name>Company Name</Partition.P_Name>
  <Partition.P_CompanyId>My Company Id</Partition.P_CompanyId>
 </Item>
</Partition>

 

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