Download OpenAPI specification:Download
運営者がシステムにログインするときに実行するAPI
m_admin を見に行き、ログイン情報が正しいかチェックする
| email required | string (メールアドレス) |
| password required | string (パスワード) |
{- "email": "string",
- "password": "string"
}{- "id": 1,
- "organization_id": 1,
- "is_organization_admin": true,
- "is_system_admin": true
}会員がシステムにログインするときに実行するAPI
m_authentication を見に行き、ログイン情報が正しいかチェックする
| email required | string (メールアドレス) |
| password required | string (パスワード) |
{- "email": "string",
- "password": "string"
}{- "id": 1,
- "organization_id": 1,
- "is_organization_admin": false,
- "is_system_admin": false
}団体の登録を行うAPI
運営者のみ実行可能
データ登録手順として初めに m_organization にデータを登録
生成された organization_id とリクエストの fiscal_year をもとにm_fiscal_year にデータを登録（順番前後可）
生成された organization_id とリクエストの password, email をもとに m_admin にデータを登録（順番前後可）
生成された fiscal_year_id と リクエストの files をもとに m_file にデータを登録する
| name required | string 団体名 |
| code required | string 団体識別コード |
| files[][file] | Array of strings ファイル |
| files[][title] | string タイトル |
| email required | string 管理者用メールアドレス |
| password required | string 管理者用パスワード |
| fiscal_yaer required | integer データ対象年度 |
{ }団体の詳細取得を行うAPI
システム運営者の場合…メールアドレスとパスワードも返却
団体管理者及び会員の場合…メールアドレスとパスワードは返却しない
| organization_id required | integer 団体ID |
{- "id": 1,
- "name": "ITCowork",
- "files": [
- {
- "title": "YEG宣言",
- "name": "https;//localhost/files/YEG宣言.pdf"
}, - {
- "title": "指針",
- "name": "https;//localhost/files/指針.pdf"
}
], - "email": "tq5hm2_fo0qg4@hotmail.com",
- "password": "IGzUwDb_F_Wv1G7"
}団体の更新を行うAPI
運営者及び団体管理者のみ実行可能
システム運営者の場合…メールアドレス及びパスワード変更可能
団体管理者の場合…メールアドレス及びパスワード変更不可
| organization_id required | integer 団体ID |
| name required | string 団体名 |
| code required | string 団体識別コード |
| files[][file] | string <binary> ファイル |
| files[][title] | string タイトル |
| emai | string メールアドレス |
| password | string パスワード |
{ }団体ID 及び データ対象年度 に紐づく会員の一覧取得を行うAPI
| organization_id required | integer 団体ID |
| fiscal_year_id required | integer データ対象年度ID |
{- "members": [
- {
- "id": 1,
- "file_name": "hoge.png",
- "name": "山田 太郎",
- "age": 27,
- "position": null,
- "committee_id": 1,
- "admission_year": "R6"
}, - {
- "id": 2,
- "file_name": "fuga.rng",
- "name": "山田 花子",
- "age": 30,
- "position": "副会長",
- "committee_id": 2,
- "admission_year": "R6"
}
]
}会員の登録を行うAPI
| file required | string <binary> 顔写真ファイル |
| name required | string 会員名 |
| name_kana required | string 会員名（かな） |
| birthday required | string <date> 誕生日 |
| admission_year required | string <date> 入会年 |
| position | string or null 役職 |
| committee_id required | integer 委員会ID |
| workplace_name required | string 勤務先名 |
| workplace_address required | string 勤務先住所 |
| workplace_position | string or null 勤務先役職 |
| workplace_phone_number required | string 勤務先TEL |
| workplace_fax_number | string or null 勤務先FAX |
| phone_number | string 電話番号 |
| email required | string メールアドレス |
| workplace_hp_url | string 会社ホームページURL |
| job_category required | string 職種 |
| industry_id required | integer 業種ID |
| hobby | string or null 趣味 |
| home_address | string or null 自宅住所 |
| home_phone_number | string or null 自宅TEL |
| home_fax_number | string 自宅FAX |
| organization_id required | integer 団体ID |
| fiscal_year_id required | integer データ対象年度ID |
{ }{- "id": 1,
- "file_name": "https;//localhost/files/yamada.png",
- "name": "山田 太郎",
- "name_kana": "やまだ たろう",
- "birthday": "1998-05-10",
- "admission_year": "2020",
- "position": 26,
- "committee_id": 1,
- "workplace_name": "株式会社ほげ",
- "workplace_address": "031-0084 青森県八戸市江陽5丁目",
- "workplace_position": null,
- "workplace_phone_number": "000-000-0000",
- "workplace_fax_number": "000-000-0000",
- "phone_number": "000-000-0000",
- "email": "g16k2f96@gmail.com",
- "job_category": "シニアアプリケーション代表者",
- "industry_id": 1,
- "hobby": "釣り",
- "home_address": null,
- "home_phone_number": null,
- "home_fax_number": null,
- "fiscal_year": 2024
}会員の更新を行うAPI
| member_id required | integer 会員ID |
| file | string <binary> 顔写真ファイル |
| name | string 名前 |
| name_kana | string 名前（かな） |
| birthday | string <date> 誕生日 |
| admission_year | string <date> 入会年 |
| position | string or null 役職 |
| committee_id | integer 委員会ID |
| workplace_name | string 勤務先名 |
| workplace_address | string 勤務先住所 |
| workplace_position | string or null 勤務先役職 |
| workplace_phone_number | string 勤務先TEL |
| workplace_fax_number | string or null 勤務先FAX |
| phone_number | string or null 電話番号 |
| workplace_hp_url | string or null 会社ホームページURL |
| job_category | string 職種 |
| industry_id | integer 業種ID |
| hobby | string or null 趣味 |
| home_address | string or null 自宅住所 |
| home_phone_number | string or null 自宅TEL |
| home_fax_number | string or null 自宅FAX |
{ }団体ID に紐づく委員会の登録を行うAPI
| name required | string 委員会名 |
| organization_id required | integer 団体ID |
| fiscal_year_id required | integer データ対象年度ID |
{- "name": "南部園スクラム8",
- "organization_id": 1,
- "fiscal_year_id": 1
}{ }業種の登録を行うAPI
| name required | string 業種名 |
| organization_id required | integer 団体ID |
| fiscal_year_id required | integer データ対象年度ID |
{- "name": "食べる",
- "organization_id": 1,
- "fiscal_year_id": 1
}{ }次年度データの作成を行うAPI
リクエストされたデータ対象年度IDに紐づく会員、委員会、業種のデータをコピーして次年度データとして作成する
| fiscal_year_id required | integer データ対象年度ID |
{- "fiscal_year_id": 1
}{ }