コース並び替え
curl --request PATCH \
--url https://api.utage-system.com/v1/members/{site_id}/courses/reorder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"course_ids": [
"<string>"
],
"groups": [
{
"course_group_id": "<string>",
"course_ids": [
"<string>"
]
}
]
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/courses/reorder"
payload = {
"course_ids": ["<string>"],
"groups": [
{
"course_group_id": "<string>",
"course_ids": ["<string>"]
}
]
}
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({
course_ids: ['<string>'],
groups: [{course_group_id: '<string>', course_ids: ['<string>']}]
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/courses/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/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([
'course_ids' => [
'<string>'
],
'groups' => [
[
'course_group_id' => '<string>',
'course_ids' => [
'<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}/courses/reorder"
payload := strings.NewReader("{\n \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\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/reorder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/courses/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 \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"course_group_id": "<string>",
"order": 123
}
]
}{
"error": {
"code": "bad_request",
"message": "course_display_type=allのサイトではcourse_idsで指定してください"
}
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "ページが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "サイト配下の全コースIDを指定してください"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}コース
コース並び替え
コースの表示順を変更します。会員サイトの course_display_type によってリクエストの形式が変わります。
allのサイト:course_idsに、削除したコースを除く全てのコースIDを並べたい順で指定しますgroup/only_groupのサイト:groupsに、コースグループごとのコースの並びを指定します。配列の順がコースグループの表示順になり、各コースの所属コースグループもこの指定のとおりに変わります(コースの所属変更はこのAPIで行います)。全てのコースグループと、削除したコースを除く全てのコースを含める必要があります。未分類(course_group_idが null)の要素は、未分類にするコースが無い場合は省略できます
形式が course_display_type と合わない場合(all のサイトで groups、group / only_group のサイトで course_ids を指定)は 400(bad_request)です。必要な方のキーが無い、IDに過不足がある、course_group_id が重複している場合は 422(validation_error)です。
応答は並び替え後の全コース(表示順)です。表示順(order)は 0 から順に付け直されます。
コース並び替え
curl --request PATCH \
--url https://api.utage-system.com/v1/members/{site_id}/courses/reorder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"course_ids": [
"<string>"
],
"groups": [
{
"course_group_id": "<string>",
"course_ids": [
"<string>"
]
}
]
}
'import requests
url = "https://api.utage-system.com/v1/members/{site_id}/courses/reorder"
payload = {
"course_ids": ["<string>"],
"groups": [
{
"course_group_id": "<string>",
"course_ids": ["<string>"]
}
]
}
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({
course_ids: ['<string>'],
groups: [{course_group_id: '<string>', course_ids: ['<string>']}]
})
};
fetch('https://api.utage-system.com/v1/members/{site_id}/courses/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/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([
'course_ids' => [
'<string>'
],
'groups' => [
[
'course_group_id' => '<string>',
'course_ids' => [
'<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}/courses/reorder"
payload := strings.NewReader("{\n \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\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/reorder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/members/{site_id}/courses/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 \"course_ids\": [\n \"<string>\"\n ],\n \"groups\": [\n {\n \"course_group_id\": \"<string>\",\n \"course_ids\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"course_group_id": "<string>",
"order": 123
}
]
}{
"error": {
"code": "bad_request",
"message": "course_display_type=allのサイトではcourse_idsで指定してください"
}
}{
"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/reorder
Body
application/json