12.5 API リファレンス – 学び～と

管理者
基本機能

API基本情報
ユーザー管理
グループ管理
属性管理

API基本情報

認証情報

管理サイトで発行したAPIキーをリクエストヘッダーに設定します。詳細は各API情報を参照ください。
APIキーの発行方法についてはAPI管理からご確認いただけます。
APIキーの発行・利用共にサイト管理者の権限を持つユーザーのみ可能です。
ログイン出来ない状態（無効、仮登録、有効期間外等）のユーザーが保有するAPIキーは利用できません。

リクエスト制限

ご利用のサイト全体で1時間あたり5000回までリクエストを受け付けます。
認証に失敗したリクエストはカウントされず、API利用ログにも記録されません。
5000回を超えた場合APIリクエストに制限がかかるため、次の00分まで時間を空けてから再度実行してください。

ユーザー管理

PATCH https://manabeat.com/{site_id}/mana_apis/user_list

ユーザーの一覧情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
get_count [必須]	boolean	true: ユーザー数のみ取得。false: 一覧情報を取得。
order	enum	昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort	enum	一覧情報をソートする項目。[“id”, “login”, “last_name”, “first_name”]から選択。デフォルト：”login”
per	integer	一覧情報の取得単位。デフォルト及び上限値：1,000
page	integer	perで区切られた一覧情報のインデックス。デフォルト：1
keyword	[string]	フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目：ログインID, 姓, 名
group_codes	[string]	グループコードによる絞り込み。複数値でOR検索が可能。
properties	[string]	属性名による絞り込み。複数値でOR検索が可能。
status	enum	ユーザーステータス（無効/仮登録/アカウントロック）による絞り込み。[“invalid_flag”, “temporary_user_flag”, “locked”]から選択。
*face_approved	boolean	顔情報承認状況による絞り込み。true: 顔情報承認済み

*オプション利用中のみ

リクエストボディ例

{
"get_count": false,
"sort": "id",
"page": 2,
"keyword": ["学習"]
}

レスポンス情報

レスポンスボディ

key	type	description
count	integer	取得ユーザー数。get_count: true 時に返却。
page	{current: integer, max: integer}	一覧のインデックス情報。current: 現在値, max: 上限値
per	integer	リストの取得単位
users	[{ id: integer, login: string, last_name: string, first_name: string }]	ユーザーリスト。ユーザーID, ログインID, 姓, 名を取得

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	使用出来ないパラメータが含まれています。parameter1…	メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400	必須パラメータが不足しています。parameter1…	一覧情報取得に必須のパラメータが不足しています。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

GET https://manabeat.com/{site_id}/mana_apis/user_show/{user_id}

指定したユーザーの詳細情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
user_id [必須]	string	ユーザーID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	ユーザーID
*face	string	顔情報認証状況
login	string	ログインID
last_name	string	姓
first_name	string	名
last_name_kana	string	姓（カナ）
first_name_kana	string	名（カナ）
email	string	メールアドレス
email2	string	メールアドレス（サブ）
valid_start_date	string	有効開始日
valid_end_date	string	有効終了日
role	string	権限名
groups	[{group_code: string, name: string}]	グループ（グループコード, グループ名）
properties	[string]	属性名
invalid_flag	boolean	無効
temporary_user_flag	boolean	仮登録
language	string	使用言語
note	string	備考
*saml_idps	[string]	SAML認証用ユーザーID
creator	string	登録者
created_at	string	登録日時
updater	string	更新者
updated_at	string	更新日時

*オプション利用中のみ

レスポンスボディ例

{
"id": 123456789,
"face": "approved",
"login": "example001",
"last_name": "学習",
"first_name": "太郎",
"last_name_kana": "ガクシュウ",
"first_name_kana": "タロウ",
"email": "api1@example.com",
"email2": "api2@example.com",
"valid_start_date": "2024-09-01",
"valid_end_date": "2027-08-31",
"role": "受講者（student）",
"groups":[
{
"group_code": "english",
"name": "英語専攻"
}
],
"properties":[
"生徒", "1年生"
],
"invalid_flag": null,
"temporary_user_flag": true,
"language": "英語 (English)",
"note": "備考欄",
"saml_idps":[
"SAMLUSERID001"
],
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12"
}

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	ユーザーが存在しません。	取得するユーザーが存在しません。ユーザーIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

POST https://manabeat.com/{site_id}/mana_apis/user_create

新規ユーザーを登録します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
login [必須]	string	ログインID
last_name [必須]	string	姓
first_name [必須]	string	名
last_name_kana	string	姓（カナ）
first_name_kana	string	名（カナ）
email	string	メールアドレス
email2	string	メールアドレス（サブ）
password [必須]	string	パスワード
valid_start_date	string	有効開始日（yyyy/mm/dd）
valid_end_date	string	有効終了日（yyyy/mm/dd）
role [必須]	string	権限名（例：受講者（student））
group_codes	[string]	グループコード
properties	[string]	属性名
invalid_flag	boolean	無効
temporary_user_flag	boolean	仮登録
language	string	使用言語名（デフォルト：日本語 (Japanese)）
note	string	備考
scheduled_signup_mail	boolean	ログインID発行通知メール送信（trueの場合はemail必須）
*saml_idps	[string]	SAML認証用ユーザーID

*オプション利用中のみ

リクエストボディ例

{
"login": "example001",
"last_name": "学習",
"first_name": "太郎",
"last_name_kana": "ガクシュウ",
"first_name_kana": "タロウ",
"email": "api1@example.com",
"email2": "api2@example.com",
"password": "1234abcd"
"valid_start_date": "2024-09-01",
"valid_end_date": "2027-08-31",
"role": "受講者（student）",
"group_codes":[
"english", "math"
],
"properties":[
"生徒", "1年生"
],
"invalid_flag": false,
"temporary_user_flag": false,
"language": "英語 (English)",
"note": "備考欄",
"saml_idps":[
"SAMLUSERID001"
]
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	登録されたユーザーのユーザーID（エラー返却時はnull）
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”ユーザーを登録しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	ユーザー登録数が上限に達しています。	サイトに登録されているユーザー数が契約内容の上限に達しています。
400	必須パラメータが不足しています。parameter1…	ユーザー登録に必須の項目が不足しています。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

PATCH https://manabeat.com/{site_id}/mana_apis/user_update/{user_id}

指定したユーザーの情報を更新します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
user_id [必須]	string	ユーザーID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
login	string	ログインID
last_name	string	姓
first_name	string	名
last_name_kana	string	姓（カナ）
first_name_kana	string	名（カナ）
email	string	メールアドレス
email2	string	メールアドレス（サブ）
password	string	パスワード
valid_start_date	string	有効開始日（yyyy/mm/dd）
valid_end_date	string	有効終了日（yyyy/mm/dd）
role	string	権限名（例：受講者（student））
group_codes	[string]	グループコード
properties	[string]	属性名
invalid_flag	boolean	無効
temporary_user_flag	boolean	仮登録
language	string	使用言語名（デフォルト：日本語 (Japanese)）
note	string	備考
*saml_idps	[string]	SAML認証用ユーザーID

*オプション利用中のみ

リクエストボディ例

{
"valid_end_date": "2027-09-30",
"group_codes":[],
"invalid_flag": true,
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定したユーザーのユーザーID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”ユーザーを更新しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	ユーザーが存在しません。	更新するユーザーが存在しません。ユーザーIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

DELETE https://manabeat.com/{site_id}/mana_apis/user_destroy/{user_id}

指定したユーザーを削除します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
user_id [必須]	string	ユーザーID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定したユーザーのユーザーID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”ユーザーを削除しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	このユーザーは削除できません。	削除する事の出来ないユーザーです。ユーザー情報を確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	ユーザーが存在しません。	削除するユーザーが存在しません。ユーザーIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

グループ管理

PATCH https://manabeat.com/{site_id}/mana_apis/group_list

グループの一覧情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
get_count [必須]	boolean	true: グループ数のみ取得。false: 一覧情報を取得。
order	enum	昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort	enum	一覧情報をソートする項目。[“id”, “name”, “group_code”]から選択。デフォルト：”id”
per	integer	一覧情報の取得単位。デフォルト及び上限値：1,000
page	integer	perで区切られた一覧情報のインデックス。デフォルト：1
keyword	[string]	フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目：グループ名

リクエストボディ例

{
"get_count": false,
"sort": "group_code",
"order": "desc",
"per": 50
}

レスポンス情報

レスポンスボディ

key	type	description
count	integer	取得グループ数。get_count: true 時に返却。
page	{current: integer, max: integer}	一覧のインデックス情報。current: 現在値, max: 上限値
per	integer	リストの取得単位
groups	[{ id: integer, name: string, group_code: string, parent_id: integer, parent_code: string, deletable: boolean, public_status: boolean }]	グループ情報。グループID, グループ名, グループコード, 親グループID, 親グループコード, 削除の可否, 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）を取得

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	使用出来ないパラメータが含まれています。parameter1…	メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400	必須パラメータが不足しています。parameter1…	一覧情報取得に必須のパラメータが不足しています。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

GET https://manabeat.com/{site_id}/mana_apis/group_show/{group_id}

指定したグループの詳細情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
group_id [必須]	string	グループID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	グループID
name	string	グループ名
group_code	string	グループコード
parent_id	integer	親グループID
parent_code	string	親グループコード
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考
creator	string	登録者
created_at	string	登録日時
updater	string	更新者
updated_at	string	更新日時
deletable	boolean	削除の可否

レスポンスボディ例

{
"id": 123456789,
"name": "管理者グループ",
"group_code": "admingroup",
"parent_id": 987654321,
"parent_code": "superadmin",
"public_status": false,
"note": "管理者のグループ",
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12",
"deletebale": false
}

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	グループが存在しません。	取得するグループが存在しません。グループIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

POST https://manabeat.com/{site_id}/mana_apis/group_create

新規グループを登録します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
name [必須]	string	グループ名
group_code [必須]	string	グループコード
parent_code	string	親グループコード
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考

*オプション利用中のみ

リクエストボディ例

{
"name": "学習グループ",
"group_code": "studygroup",
"parent_code": "admingroup",
"public_status": true,
"note": "学習者のグループ"
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	登録されたグループのグループID（エラー返却時はnull）
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”グループを登録しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	グループ登録数が上限に達しています。	サイトに登録されているグループ数が上限に達しています。
400	必須パラメータが不足しています。parameter1…	グループ登録に必須の項目が不足しています。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

PATCH https://manabeat.com/{site_id}/mana_apis/group_update/{group_id}

指定したグループの情報を更新します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
group_id [必須]	string	グループID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
name	string	グループ名
group_code	string	グループコード
parent_code	string	親グループコード。親グループを解除する場合は空文字列””を入力
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考

リクエストボディ例

{
"group_code": "singlegroup",
"parent_code": ""
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定したグループのグループID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”グループを更新しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	グループが存在しません。	更新するグループが存在しません。グループIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

DELETE https://manabeat.com/{site_id}/mana_apis/group_destroy/{group_id}

指定したグループを削除します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
group_id [必須]	string	グループID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定したグループのグループID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”グループを削除しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	このグループは削除できません。	削除する事の出来ないグループです。グループ情報を確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	グループが存在しません。	削除するグループが存在しません。グループIDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

属性管理

PATCH https://manabeat.com/{site_id}/mana_apis/property_list

属性の一覧情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
get_count [必須]	boolean	true: 属性数のみ取得。false: 一覧情報を取得。
order	enum	昇順/降順。[“asc”, “desc”]から選択。デフォルト：”asc”
sort	enum	一覧情報をソートする項目。[“id”, “name”]から選択。デフォルト：”id”
per	integer	一覧情報の取得単位。デフォルト及び上限値：1,000
page	integer	perで区切られた一覧情報のインデックス。デフォルト：1
keyword	[string]	フリーワード検索による絞り込み。複数値でAND検索が可能。検索項目：属性名

リクエストボディ例

{
"get_count": false,
"sort": "name",
"order": "desc",
"per": 50
}

レスポンス情報

レスポンスボディ

key	type	description
count	integer	取得属性数。get_count: true 時に返却。
page	{current: integer, max: integer}	一覧のインデックス情報。current: 現在値, max: 上限値
per	integer	リストの取得単位
properties	[{ id: integer, name: string, deletable: boolean, public_status: boolean }]	属性情報。属性ID, 属性名, 削除の可否, 利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）を取得

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	使用出来ないパラメータが含まれています。parameter1…	メッセージに記載された項目のパラメータが使用できません。データ型等確認してください。
400	必須パラメータが不足しています。parameter1…	一覧情報取得に必須のパラメータが不足しています。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

GET https://manabeat.com/{site_id}/mana_apis/property_show/{property_id}

指定した属性の詳細情報を取得します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
property_id [必須]	string	属性ID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	属性ID
name	string	属性名
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考
creator	string	登録者
created_at	string	登録日時
updater	string	更新者
updated_at	string	更新日時
deletable	boolean	削除の可否

レスポンスボディ例

{
"id": 123456789,
"name": "英語",
"public_status": false,
"note": "英語割り当て用の属性",
"creator": "管理者 user001",
"created_at": "2024-07-23 00:00:00",
"updater": "管理者 user002",
"updated_at": "2024-07-24 12:12:12",
"deletebale": false
}

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	属性が存在しません。	取得する属性が存在しません。属性IDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

POST https://manabeat.com/{site_id}/mana_apis/property_create

新規属性を登録します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
name [必須]	string	属性名
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考

*オプション利用中のみ

リクエストボディ例

{
"name": "数学"
"public_status": true,
"note": "数学割り当て用の属性"
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	登録された属性の属性ID（エラー返却時はnull）
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”属性を登録しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	属性登録数が上限に達しています。	サイトに登録されている属性数が上限に達しています。
400	必須パラメータが不足しています。parameter1…	属性登録に必須の項目が不足しています。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

PATCH https://manabeat.com/{site_id}/mana_apis/property_update/{property_id}

指定した属性の情報を更新します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
property_id [必須]	string	属性ID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}
Content-Type [必須]	application/json

リクエストボディ

key	type	description
name	string	属性名
public_status	boolean	利用者自身の登録可否（サイト設定で「利用者自身によるグループ・属性登録設定可」をONにしている場合のみ）
note	string	備考

リクエストボディ例

{
"name": "数学（受講完了）",
"public_status": false
}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定した属性の属性ID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”属性を更新しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	Content-Type情報が不正な値です。	リクエストヘッダー情報を確認してください。
400	リクエスト内容を認識できません。	リクエストボディの読み込みに失敗しました。送信データを確認してください。
400	登録出来ないデータが含まれています。parameter1…	メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	属性が存在しません。	更新する属性が存在しません。属性IDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。

DELETE https://manabeat.com/{site_id}/mana_apis/property_destroy/{property_id}

指定した属性を削除します。

リクエスト情報

パスパラメータ

key	type	description
site_id [必須]	string	サイトID
property_id [必須]	string	属性ID

ヘッダー情報

key	value
Authorization [必須]	Bearer {api_key}

レスポンス情報

レスポンスボディ

key	type	description
id	integer	指定た属性の属性ID
status_code	string	レスポンスステータスが返却されます
message	string	API実行結果（正常値：”属性を削除しました。”）

エラーレスポンス

status_code	message	description
400	URLに誤りがあります。	リクエストURL、パスパラメータを確認してください。
400	この属性は削除できません。	削除する事の出来ない属性です。属性情報を確認してください。
403	認証に失敗しました。	APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。
403	許可されていないIPからのリクエストです。	IPアドレス制限によってリクエストが制限されています。
404	属性が存在しません。	削除する属性が存在しません。属性IDを確認してください。
429	リクエスト制限中です。	1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。
500	予期せぬエラーが発生しました。	システム内部でエラーが発生しました。時間をおいて再度お試しください。
503	システムメンテナンス中です。	現在システム全体のメンテナンス中です。終了までお待ちください。