部署リストの取得
このAPIは、現在の企業の部署リスト情報を取得するために使用されます。
リクエストメソッド
GET /departments
リクエストパラメータ
なし
レスポンスデータ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード、1000は成功を表します |
| departments | 配列 | 詳細は以下を参照してください |
departmentsの構造
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| id | 整数型 | 部署ID |
| name | 文字列 | 部署名 |
| sub_department | 配列 | サブ部署 |
例
リクエスト
curl https://demo.udesk.cn/open_api_v1/departments?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X GET \
-H 'content-type: appliacation/json' \
レスポンス
{
"code": 1000,
"departments": [
{
"id": 1,
"name": "部署1",
"sub_department": [
{
"id": 10,
"name": "サブ部署1",
"sub_department": [ {"id": 11, "name": "サブ部署2", "sub_department": []} ]
},
{
"id": 11,
"name": "サブ部署2",
"sub_department": []
}
]
},
{
"id": 2,
"name": "部署2",
"sub_department": []
},
{
"id": 3,
"name": "部署3",
"sub_department": []
}
]
}
部署の作成
このAPIは部署を作成するために使用されます。
リクエストメソッド
POST /departments
リクエストパラメータ（リクエストボディ）
| パラメータ | 必須 | タイプ | 説明 | 制限 | デフォルト |
|---|---|---|---|---|---|
| name | はい | 文字列 | 部門名 | 255文字以内 | |
| parent_id | いいえ | 整数 | 親部門ID | 0 |
注意： parent_idは親部門のIDです。指定しない場合、デフォルトは0となります。parent_idが0の場合は親部門が存在しないことを意味します。
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| id | 整数 | 作成に成功した部門ID |
例
リクエスト
curl https://demo.udesk.cn/open_api_v1/departments?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
"name": "部門12",
"parent_id": 1
}'
レスポンス
{
"code": 1000,
"id": 5
}
部門編集
このAPIは、既存の部門の基本情報を編集するために使用されます。
リクエストメソッド
PUT /departments/:id
リクエストパラメータ（URL）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| id | 整数 | はい | 部門ID |
リクエストパラメータ（リクエストボディ）
| パラメータ | 必須 | タイプ | 説明 | 制限 | デフォルト |
|---|---|---|---|---|---|
| name | はい | 文字列 | 部門名 | 255文字以内 |
注意：このAPIはIDに基づいて部門のnameのみを変更でき、部門のparent_idは変更できません。つまり、部門の階層関係を変更することはできません。 リクエストパラメータにparent_idを追加しても、効果はなく、エラーメッセージも表示されません。
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| department | オブジェクト | 部門情報、構造は以下の通り |
departmentの構造
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 部門ID |
| name | 文字列 | 部門名 |
| parent_id | 整数 | 親部門ID |
| ### サンプル |
リクエスト
curl https://demo.udesk.cn/open_api_v1/departments/5?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '{"name": "新部門12"}'
レスポンス
{
"code": 1000,
"department": {
"id": 5,
"name": "新部門12",
"parent_id": 1
}
}
部門の削除
このAPIは既存の部門を削除するために使用されます。
リクエストメソッド
DELETE /departments/:id
リクエストパラメータ(url)
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| id | 整数 | はい | 部門ID |
リクエストパラメータ(request body)
なし
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| message | 文字列 | 実行結果の説明 |
サンプル
リクエスト
curl https://demo.udesk.cn/open_api_v1/departments/5?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: application/json' \
レスポンス
{
"code": 1000,
"message": "IDが5の部門の削除に成功しました"
}
コードエラー
| エラーコード | message情報 | exception:message情報 | 説明 |
|---|---|---|---|
| 2000 | 不明なエラー | 検証失敗: Nameは既に使用されています | Nameは既に使用されています |
| parent_idがxxxの上位部門は存在しません | なし | parent_idがxxxの上位部門は存在しません | |
| 渡されたparent_idが非負整数ではありません | なし | 渡されたparent_idの形式が正しくありません。非負整数ではありません | |
| 該当リソースが見つかりませんでした | なし | 渡されたIDに基づき、編集対象の部門が見つかりませんでした。IDが存在しないか、IDの形式が誤っている可能性があります | |
| 2015 | 管理者のみ操作可能です | 管理者のみ操作可能です | APIを呼び出す際のメールアドレスは管理者のものである必要があります。管理者以外は操作できません |
| 2059 | Open APIの署名が正しくありません | Open APIの署名が正しくありません | Open APIの署名が正しくありません。詳細は認証セクションのドキュメントを参照してください |