組織作成
目的
組織を作成します。
基本項目
| 項目 | 値 | 備考 |
|---|---|---|
| url | /api/admin/organization | |
| メソッド | POST | |
| content-type | application/json | |
| 文字コード | utf-8 |
リクエスト
ヘッダ
| ヘッダ名 | 値 |
|---|---|
| X-fn-gene-api-idtoken | Firebase ID Token |
パラメータ(URL)
なし
パラメータ(クエリ)
なし
ボディ(JSON)
| パラメータ名 | 名称 | 型 | サイズ |
|---|---|---|---|
| name | 組織名 | string | |
| url | セールスフォースURL | string | |
| description | 備考 | string |
{
"name" : "上野牧場",
"url": "https://xxxxxxxxxxxxxxxxxxxx",
"description": "上野にある牧場",
}
レスポンス
レスポンスステータス
| HTTPステータス | 内容 |
|---|---|
| 201 | 成功追加 |
| 400 | リクエストBODYエラー |
| 401 | 認証エラー |
| 404 | 対象がない |
| 500 | その他エラー |
ボディ(JSON)
| パラメータ名 | 名称 | 型 | サイズ |
|---|---|---|---|
| farmid | 組織ID | String | 10Byte |
| name | 組織名 | String | |
| description | 備考 | String | |
| url | セールスフォースURL | String | |
| regist_date | 登録日時 | Timestamp |
※登録内容がレスポンスされます。
レスポンスサンプル
- Content-Type Application/Json
{
"farmid": "sXpE1ckVhP",
"name": "東京牧場",
"description": "東京の牧場",
"url": "https://xxxxxxxxxxxxxxxxxxxx",
"regist_date": "2022-06-03T07:13:38.179Z"
}
```