Endpoint
| field | value |
|---|
| method | DELETE |
| path | /api/integrations/v1/companies/{company_id}/branches/{branch_id} |
| operationId | delete_branch_for_integration |
| auth | server to server integration client token |
| Idempotency-Key | required |
| lifecycle | stable |
| resource type | branch |
| data classification | internal |
| scope risk | high |
| write operation | yes |
Summary
対象 を削除します
Required scope
| scope | requirement |
|---|
| branches:delete | required |
Operation contract
| field | value |
|---|
| bulk mode | - |
| bulk max items | - |
| bulk dry run | - |
| sync type | - |
| sync max limit | - |
| reconciliation | - |
Path parameters
| name | required | schema |
|---|
| company_id | required | integer |
| branch_id | required | integer |
Query parameters
Header parameters
| name | required | schema |
|---|
| Idempotency-Key | required | string |
Request body
| status | media type | schema |
|---|
| - | - | - |
| - | - | - |
Response
| status | media type | schema |
|---|
| 200 | application/json | SuccessResponse_IdOnlyResponse_ |
Example
curl -X DELETE "https://api.anshin.care/api/integrations/v1/companies/{company_id}/branches/{branch_id}" \
-H "Authorization: Bearer $ANSHIN_INTEGRATION_ACCESS_TOKEN" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
業務境界
- domain: 事業所
- endpoint は各 backend の S2S scoped OpenAPI artifact から同期しています。
- company 境界は backend で検証します。
- write 系 endpoint は、画面用 API と endpoint を分け、処理本体は service 層で共通化します。