レッスン並び替え
curl --request PATCH \
--url https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"lesson_group_id": "xxxxxxxxxx",
"lesson_ids": [
"yyyyyyyyyy",
"zzzzzzzzzz"
]
},
{
"lesson_group_id": "wwwwwwwwww",
"lesson_ids": []
}
]
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder"
payload = { "groups": [
{
"lesson_group_id": "xxxxxxxxxx",
"lesson_ids": ["yyyyyyyyyy", "zzzzzzzzzz"]
},
{
"lesson_group_id": "wwwwwwwwww",
"lesson_ids": []
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{lesson_group_id: 'xxxxxxxxxx', lesson_ids: ['yyyyyyyyyy', 'zzzzzzzzzz']},
{lesson_group_id: 'wwwwwwwwww', lesson_ids: []}
]
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder', 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}/courses/{course_id}/lessons/reorder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'groups' => [
[
'lesson_group_id' => 'xxxxxxxxxx',
'lesson_ids' => [
'yyyyyyyyyy',
'zzzzzzzzzz'
]
],
[
'lesson_group_id' => 'wwwwwwwwww',
'lesson_ids' => [
]
]
]
]),
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}/courses/{course_id}/lessons/reorder"
payload := strings.NewReader("{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"lesson_group_id": "<string>",
"type": "html",
"order": 123
}
]
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "コースが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "コース配下の全レッスンIDを指定してください"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}レッスン
レッスン並び替え
レッスングループとレッスンの表示順を変更します(管理画面「レッスン管理」の「並べ替え」と同じ操作)。
groups の配列順がレッスングループの表示順、各グループの lesson_ids の順がグループ内のレッスンの表示順になります。レッスンを別のグループの lesson_ids に入れると所属グループが変わります。
コース配下の全レッスングループと全レッスン(コンテンツエディター・リッチテキストの両方)を過不足なく含める必要があります(過不足や lesson_group_id の重複は 422)。
全レッスンの ID は GET /members/{site_id}/courses/{course_id}/lessons を type=all で、lesson_group_id / is_published を指定せずに全ページ取得してください。レッスンが無いグループは lesson_ids を空配列にします。
レッスン並び替え
curl --request PATCH \
--url https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"lesson_group_id": "xxxxxxxxxx",
"lesson_ids": [
"yyyyyyyyyy",
"zzzzzzzzzz"
]
},
{
"lesson_group_id": "wwwwwwwwww",
"lesson_ids": []
}
]
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder"
payload = { "groups": [
{
"lesson_group_id": "xxxxxxxxxx",
"lesson_ids": ["yyyyyyyyyy", "zzzzzzzzzz"]
},
{
"lesson_group_id": "wwwwwwwwww",
"lesson_ids": []
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{lesson_group_id: 'xxxxxxxxxx', lesson_ids: ['yyyyyyyyyy', 'zzzzzzzzzz']},
{lesson_group_id: 'wwwwwwwwww', lesson_ids: []}
]
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder', 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}/courses/{course_id}/lessons/reorder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'groups' => [
[
'lesson_group_id' => 'xxxxxxxxxx',
'lesson_ids' => [
'yyyyyyyyyy',
'zzzzzzzzzz'
]
],
[
'lesson_group_id' => 'wwwwwwwwww',
'lesson_ids' => [
]
]
]
]),
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}/courses/{course_id}/lessons/reorder"
payload := strings.NewReader("{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groups\": [\n {\n \"lesson_group_id\": \"xxxxxxxxxx\",\n \"lesson_ids\": [\n \"yyyyyyyyyy\",\n \"zzzzzzzzzz\"\n ]\n },\n {\n \"lesson_group_id\": \"wwwwwwwwww\",\n \"lesson_ids\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"lesson_group_id": "<string>",
"type": "html",
"order": 123
}
]
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "コースが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "コース配下の全レッスンIDを指定してください"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}PATCH
https://api.utage-system.com/v1/members/{site_id}/courses/{course_id}/lessons/reorder
Body
application/json