本部グループの登録・更新を行えます。
アカウントデータを CSV ファイルで作成し、WebAPI でアップロードします。
呼び出し先URL
{your-domain} の部分をご利用環境に合わせて変更してください。
https://{your-domain}/h2/UserGroupManipurator.doリクエスト
| パラメータ名 | 意味 | 必須 | 制約・説明 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず importCsv を指定します。 |
key | WebAPIキー | 〇 | アカウント管理APIが利用可能な WebAPIキーを指定します。 |
csv | CSVファイル | 〇 | 本部グループ情報の CSV ファイルを指定します。 |
force | エラーを無視してインポートを実施するか | 1 または 0 を指定します。1 : エラーとなったデータを無視し、追加・変更可能なデータのみインポートします。0 : エラーとなったデータが存在する場合、追加・変更可能なデータも含めてインポートしません。 | |
revive | 削除済みのグループを復活するか | 指定したグループコードの本部グループが現在存在しない場合に、削除済みグループを復活させるかを指定します。1 : 同一グループコードの削除済みグループがあれば復活します。複数ある場合は最後に更新されたグループを復活します。0 : 新しく本部グループを追加します。 |
注意事項
- グループのインポートは差分ではなく全件対象 です。CSV ファイルには 全グループの情報 を登録してください。
- CSV ファイルに存在しないグループは 削除 されます。
補足事項
force=1の場合、エラーとなったデータについては、レスポンスのinfoに詳細なエラーメッセージ、error-linesにエラーとなった行番号が出力されます。forceのデフォルトは0です。reviveのデフォルトは0です。
レスポンス
API の呼び出し結果は、以下のスキーマの XML 文書として返されます。
<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="response">
<xsd:sequence>
<xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="info" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="error-lines" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:element>
</xsd:schema>
レスポンス要素
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 1 : 成功4 : 入力パラメータの内容にエラーがある8 : その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合、詳細なエラーメッセージが文字列で返されます。 |
//response/info | 更新ログ | 本部グループアカウントを更新したログが文字列で出力されます。 |
//response/error-lines | エラーを無視した行番号 | force=1 を指定したとき、エラーがあった行番号をカンマ区切りで返します。 |
更新に成功した場合のレスポンスXML例
<response>
<result>1</result>
<info><![CDATA[
* 1: Modifying an existing group 00001.
* 2: Adding a new group 00007.
:
]]></info>
</response>
説明
//response/resultが1のため、呼び出しは成功です。//response/infoには、更新・追加された本部グループのグループコードが返されます。- 例では、
00001は既存の本部グループを更新、00007は新規追加を表します。
更新に失敗した場合のレスポンスXML例
<response>
<result>4</result>
<errors><![CDATA[
* 1: Modifying an existing group 00001.
* 2: Adding a new group 00007. * sortOrder is invalid. (00007)
:
]]></errors>
</response>
説明
//response/resultが4のため、呼び出しは失敗です。//response/errorsには、エラー内容が返されます。- 例では、グループコード
00007に指定した ソート順位が不正 であることを示しています。
CSVファイルの仕様
本部グループ情報の CSV ファイル仕様は以下の通りです。
〇: 必須△: 追加時は必須
| 列名 | 必須 | 桁数 | 内容 |
|---|---|---|---|
id | 〇 | 120 | グループコードを指定します。WebAPI で登録するグループにはすべてグループコードが必要です。 |
name | 〇 | 240 | グループ名を指定します。 |
phoneticName | 〇 | 240 | グループ名ふりがなを指定します。 |
sortOrder | 〇 | 3 | ソート順位を指定します。 |
parentGroup | 120 | グループが階層構造を持つ場合、このグループの上位グループコードを指定します。 | |
colors0～ | 120 | 環境の分割機能を使用しているとき、グループが所属する区分を指定できます。 |
補足事項
- グループコードの指定がない本部グループは、WebAPI から更新できません。
文字コード
本サービスでアップロードする CSV ファイルの文字コードについては、CSVファイルの仕様 を参照してください。