開発者向け機能:スクリプト:$p.apiDeptsDelete
概要¶
AjaxのPOSTリクエストにより、組織を削除します。
構文¶
パラメータ¶
| パラメータ名 | 型 | 必須 | 概要 |
|---|---|---|---|
| id | long | ○ | 削除する組織のID |
| done | function | ○ | API通信成功時の処理 |
| fail | function | API通信失敗時の処理 | |
| always | function | API通信完了時の処理 |
使用例¶
$p.apiDeptsDelete({
id: 2,
done: function (data) {
console.log(data);
console.log('組織情報の削除に成功しました。');
},
fail: function (data) {
console.log('組織情報の削除に失敗しました。');
},
always: function (data) {
console.log('組織情報の削除が完了しました。');
}
});
戻り値¶
正常終了時は以下のようなオブジェクトが返却されます。
戻り値の項目¶
| 項目 | 説明 |
|---|---|
| Id | 削除された組織のID |
| StatusCode | 実行結果のステータスコード |
| Message | 実行結果メッセージ |
補足¶
- 対象IDの組織が存在しない場合は404(Not Found)エラーが返却されます。
- 削除できない状態(参照制約など)の場合は403(Forbidden)エラーが返却されます。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.5.8.0 以降 | 機能追加 |
関連情報¶
$p.apiDeptsGet
開発者向け機能:スクリプト:$p.apiDeptsCreate
開発者向け機能:スクリプト:$p.apiDeptsUpdate
