# ビルカンAPIリファレンス

## 初期設定

- 下記コマンドを実行してtokenの発行を発行する（1がユーザidなので，操作したいユーザに合わせる）．
`php artisan user:token 1 test-token`

- 下記の結果が表示されるため，tokenを控えておく．

`Token for user ID 1: 1|lUUrZtzt945fwQXOhAEbKOZhFHogeFugaPiyo`

- postmanなどで，ヘッダに下記のようにtokenを追加してリクエストを投げる．

`Authorization: Bearer 1|lUUrZtzt945fwQXOhAEbKOZhFHogeFugaPiyo`

作成済みのエンドポイントは以下（協力会社はビル関係ないのでビルidの指定はなし）

- 協力会社
- 区画
- テナント

## 協力会社

|操作|メソッド|URL|備考|
|-|-|-|-|
|一覧|GET|http://localhost/api/agents/||
|id指定|GET|http://localhost/api/agents/{id}||
|作成|POST|http://localhost/api/agents/||
|更新|POST|http://localhost/api/agents/{id}|bodyに「_method:PUT」を追加する．|
|削除|DELETE|http://localhost/api/agents/{id}|

## 区画

|操作|メソッド|URL|備考|
|-|-|-|-|
|一覧|GET|http://localhost/api/sections/|Paramsに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）|
|id指定|GET|http://localhost/api/sections/{id}||
|作成|POST|http://localhost/api/sections/|Bodyに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）．|
|更新|POST|http://localhost/api/sections/{id}|bodyに「_method:PUT」を追加する．|
|削除|DELETE|http://localhost/api/sections/{id}|

## テナント

|操作|メソッド|URL|備考|
|-|-|-|-|
|一覧|GET|http://localhost/api/tenants/|Paramsに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）|
|id指定|GET|http://localhost/api/tenants/{id}||
|作成|POST|http://localhost/api/tenants/|Bodyに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）．|
|更新|POST|http://localhost/api/tenants/{id}|bodyに「_method:PUT」を追加する．|
|削除|DELETE|http://localhost/api/tenants/{id}|

## テナント契約書

|操作|メソッド|URL|備考|
|-|-|-|-|
|一覧|GET|http://localhost/api/contracts/|Paramsに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）．また，「tenant_id:1」のように追加することでテナントを絞ることができます．|
|id指定|GET|http://localhost/api/contracts/{id}||
|作成|POST|http://localhost/api/contracts/|Bodyに「tenant_id:1」などを追加する（tenant_idはユーザの所属しているビルのテナントidのみ動作します）．|
|更新|POST|http://localhost/api/contracts/{id}|bodyに「_method:PUT」を追加する．nameが必須．|
|削除|DELETE|http://localhost/api/contracts/{id}|

## 設備

|操作|メソッド|URL|備考|
|-|-|-|-|
|一覧|GET|http://localhost/api/facilities/|Paramsに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）|
|id指定|GET|http://localhost/api/facilities/{id}||
|作成|POST|http://localhost/api/facilities/|Bodyに「building_id:1」を追加する（building_idはユーザの所属しているビルidのみ動作します）．|
|更新|POST|http://localhost/api/facilities/{id}|bodyに「_method:PUT」を追加する．|
|削除|DELETE|http://localhost/api/facilities/{id}|