Department Read Method
Department APIは、Departmentに対するアクセスを提供します。
Department Readでは、指定した条件に対応するDepartmentのリストを取得することができます。
|
GET |
https://{Request Host}/v1/department?partition=[partition_id]&count=[取得件数]&start=[開始インデックス]&field=[出力 Field] |
|---|
Scope
Department Readを行うために必要なアクセス権は次の通りです。
user_r
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
| ー | count | 取得するデータの件数を数値で指定します。 指定できる値の範囲は、1～200までです。省略した場合は10が指定されたものとみなします。 |
| ー | start | 取得するデータの開始インデックスです。 0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。 |
| ー | field |
出力する項目を指定します。指定できるFieldは、Department - Field Listを参照してください。
|
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。Department APIで取扱可能な任意のFieldはありません。
| Tag | Definition |
|---|---|
| Department | 条件に該当するDepartmentを含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 |
| Total | Departmentの属性。指定した検索条件で取得できる総件数を示します。 |
| Count | Departmentの属性。今回取得したデータの件数を示します。 |
| Start | Departmentの属性。今回取得したデータの開始インデックスを示します。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
| Item | 一つのDepartment情報を表します。 |
| Field | 指定された項目の値を格納します。 要素の名称は、Department - Field List を参照してください。 |
Department Read Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、すべてのユーザー情報を取得する場合の例です。
|
Input Parameter https://{Request Host}/v1/department?partition=999999 &field=Department.P_Id,Department.P_Name |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Department Total="2" Count="2" Start="0"> <Code>0</Code> <Item> <Department.P_Id>1</Department.P_Id> <Department.P_Name>部署1</Department.P_Name> </Item> <Item> <Department.P_Id>2</Department.P_Id> <Department.P_Name>部署2</Department.P_Name> </Item> </Department> |