GET - Lesson Plan Metadata by ID
Retrieves metadata for a specific lesson plan by its ID. This endpoint returns details such as board, grade, section, subject, status, duration, topic, subject matter, and learning standards.
How to Use:
- Call
GET /lesson-plan/v1/metadata/{lessonPlanId}with the lesson plan ID. - On success, you receive lesson plan metadata in the response.
- If the lesson plan is not found, a 404 error is returned. If processing failed, a 400 error with the failure message is returned.
GET
/
lesson-plan
/
v1
/
metadata
/
{lesson_plan_id}
Retrieve the metadata of a lesson plan by its ID.
curl --request GET \
--url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}', 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-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"grade": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"section": "<string>",
"subject": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"status": "<string>",
"duration_minutes": 123,
"topic": "<string>",
"documents": [
{
"url": "<string>",
"file_type": "<string>"
}
],
"audio": "<string>",
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
}
},
"learning_standards": {
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"competencies": {
"competency_list": [
{
"name": "<string>",
"description": "<string>"
}
]
}
}
}
}{
"detail": [
{
"msg": "Lesson plan step failed."
}
]
}{
"detail": [
{
"msg": "Lesson plan not found."
}
]
}{
"detail": [
{
"msg": "Internal server error."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the lesson plan.
Response
Lesson plan metadata retrieved successfully.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Retrieve the metadata of a lesson plan by its ID.
curl --request GET \
--url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}', 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-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"grade": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"section": "<string>",
"subject": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"status": "<string>",
"duration_minutes": 123,
"topic": "<string>",
"documents": [
{
"url": "<string>",
"file_type": "<string>"
}
],
"audio": "<string>",
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
}
},
"learning_standards": {
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"<string>"
],
"additional_recommendations": [
"<string>"
]
}
},
"competencies": {
"competency_list": [
{
"name": "<string>",
"description": "<string>"
}
]
}
}
}
}{
"detail": [
{
"msg": "Lesson plan step failed."
}
]
}{
"detail": [
{
"msg": "Lesson plan not found."
}
]
}{
"detail": [
{
"msg": "Internal server error."
}
]
}