Dapatkan rancangan pelajaran

Parameter

Lingara-Versionheaderstringpilihan

Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapat versi yang dipautkan kepada kliennya, dan permintaan tanpa token mendapat versi semasa. Versi yang masih dalam pembangunan hanya boleh dicapai dengan menamakannya di sini. Versi yang tidak dikenali dijawab 400 dengan kod api_version_unknown. GET /v1/versions menyenaraikan versi.

idpathstringwajib

Respons

200 Rancangan pelajaran

idstringwajib

statusPlanStatuswajib

titlestring | nullpilihan

source_langstringwajib

target_langstringwajib

levelintegerwajib

created_atstringwajib

completed_atstring | nullpilihan

ai_generatedbooleanwajib

contentLessonPlanContent | nullpilihan

introductionstring | nullpilihan

learning_objectivesarray of stringwajib

vocabularyarray of PlanWordwajib

wordstringwajib

pronunciationstring | nullpilihan

translationstringwajib

setsarray of PlanSetwajib

numberintegerwajib

contextstring | nullpilihan

questionsarray of PlanQuestionwajib

typestringwajib

promptstringwajib

optionsarray of string | nullpilihan

answerstringwajib

explanationstringwajib

hintstring | nullpilihan

Ralat

410application/json

Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Hantar versi yang disokong dalam Lingara-Version, atau pautkan klien kepada versi lain.

4XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

503application/json · text/plain

Perkhidmatan tidak tersedia buat sementara waktu; cuba lagi selepas bilangan saat dalam Retry-After. Semasa penyelenggaraan, kandungan ialah teks biasa dan bukan sampul ralat.

5XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

codestringwajib

Sebab permintaan ditolak, sebagai kod stabil untuk dijadikan asas percabangan: contohnya insufficient_scope (403), rate_limited (429) dan, bagi klien bermeter, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Contoh

curl "https://api.getlingara.com/v1/lesson-plans/$ID" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

const plan = await client.getLessonPlan({ id: planId });
console.log(plan.status, plan.title);

let plan = client.get_lesson_plan(&plan_id).await?;
println!("{:?} {}", plan.status, plan.title.as_deref().unwrap_or("(untitled)"));

plan, err := client.GetLessonPlan(ctx, "3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37")
if err != nil {
	return err
}
fmt.Println(plan.Value.Status, plan.Value.CreatedAt)

import com.getlingara.client.model.LessonPlan;

LessonPlan plan = client.getLessonPlan(planId).body();
System.out.println(plan.getTitle() + " (" + plan.getStatus() + ")");

val plan = client.getLessonPlan(planId).body
println("${plan.title} (${plan.status})")

plan = client.get_lesson_plan(plan_id).value
puts "#{plan.title} (#{plan.status})"
plan.content&.vocabulary&.each { |word| puts "#{word.word}: #{word.translation}" }

$plan = $client->getLessonPlan($planId)->value;
echo $plan->getTitle(), ' (', $plan->getStatus()->value, ")\n";

Lebih suka pustaka? Lihat bahagian Pustaka.