受講生の登録コース・コミュニティ追加
curl --request POST \
--url https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "bundle",
"bundle_id": "<string>",
"course_id": "<string>",
"community_group_id": "<string>",
"enrolled_at": "<string>"
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments"
payload = {
"type": "bundle",
"bundle_id": "<string>",
"course_id": "<string>",
"community_group_id": "<string>",
"enrolled_at": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'bundle',
bundle_id: '<string>',
course_id: '<string>',
community_group_id: '<string>',
enrolled_at: '<string>'
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'bundle',
'bundle_id' => '<string>',
'course_id' => '<string>',
'community_group_id' => '<string>',
'enrolled_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments"
payload := strings.NewReader("{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "bundle",
"bundle": {
"id": "<string>",
"name": "<string>"
},
"course": {
"id": "<string>",
"name": "<string>",
"system_name": "<string>"
},
"community_group": {
"id": "<string>",
"name": "<string>"
},
"enrolled_at": "<string>",
"cancelled_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "コミュニティ機能が有効ではありません"
}
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "ページが見つかりません"
}
}{
"error": {
"code": "conflict",
"message": "既に登録されています"
}
}{
"error": {
"code": "validation_error",
"message": "入力内容に誤りがあります",
"details": {
"course_id": [
"指定されたコースが見つかりません"
]
}
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}登録コース・コミュニティ
受講生の登録コース・コミュニティ追加
受講生をバンドル・単一コース・コミュニティグループに登録します。管理画面「登録コース・コミュニティ」の「追加」と同じです。type に応じて bundle_id / course_id / community_group_id のいずれか 1 つを指定します。登録日(enrolled_at)を省略すると現在日時になります。登録日は、コースの開放日の設定で登録日を基準にする場合の起点になります。
- 指定したバンドル・コース・コミュニティグループがサイトに無い(削除済みを含む)場合は 422(
validation_error。指定した ID の項目に理由) - 同じ対象に登録済み(停止中を含む)の場合は 409(
conflict) type=community_groupで、サイトのコミュニティ機能が「利用する」でない場合は 400(bad_request)
単一コースはステータスが「下書き」のコースも指定できます。
受講生の登録コース・コミュニティ追加
curl --request POST \
--url https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "bundle",
"bundle_id": "<string>",
"course_id": "<string>",
"community_group_id": "<string>",
"enrolled_at": "<string>"
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments"
payload = {
"type": "bundle",
"bundle_id": "<string>",
"course_id": "<string>",
"community_group_id": "<string>",
"enrolled_at": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'bundle',
bundle_id: '<string>',
course_id: '<string>',
community_group_id: '<string>',
enrolled_at: '<string>'
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'bundle',
'bundle_id' => '<string>',
'course_id' => '<string>',
'community_group_id' => '<string>',
'enrolled_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments"
payload := strings.NewReader("{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"bundle\",\n \"bundle_id\": \"<string>\",\n \"course_id\": \"<string>\",\n \"community_group_id\": \"<string>\",\n \"enrolled_at\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "bundle",
"bundle": {
"id": "<string>",
"name": "<string>"
},
"course": {
"id": "<string>",
"name": "<string>",
"system_name": "<string>"
},
"community_group": {
"id": "<string>",
"name": "<string>"
},
"enrolled_at": "<string>",
"cancelled_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "コミュニティ機能が有効ではありません"
}
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "ページが見つかりません"
}
}{
"error": {
"code": "conflict",
"message": "既に登録されています"
}
}{
"error": {
"code": "validation_error",
"message": "入力内容に誤りがあります",
"details": {
"course_id": [
"指定されたコースが見つかりません"
]
}
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}POST
https://api.utage-system.com/v1/members/{site_id}/students/{student_id}/enrollments
Body
application/json