الحصول على خطة درس

المعاملات

Lingara-Versionheaderstringاختياري

إصدار API الذي يُجاب عن هذا الطلب به. بدونه، يحصل رمز الوصول على الإصدار الذي رُبط به عميله، ويحصل الطلب الذي لا رمز مميز فيه على الإصدار الحالي. لا يمكن الوصول إلى الإصدار الذي لا يزال قيد التطوير إلا بذكره هنا. الإصدار غير المعروف يُجاب عنه بـ 400 مع الرمز api_version_unknown. يسرد GET /v1/versions الإصدارات.

idpathstringمطلوب

الاستجابات

200 خطة الدرس

idstringمطلوب

statusPlanStatusمطلوب

titlestring | nullاختياري

source_langstringمطلوب

target_langstringمطلوب

levelintegerمطلوب

created_atstringمطلوب

completed_atstring | nullاختياري

ai_generatedbooleanمطلوب

contentLessonPlanContent | nullاختياري

introductionstring | nullاختياري

learning_objectivesarray of stringمطلوب

vocabularyarray of PlanWordمطلوب

wordstringمطلوب

pronunciationstring | nullاختياري

translationstringمطلوب

setsarray of PlanSetمطلوب

numberintegerمطلوب

contextstring | nullاختياري

questionsarray of PlanQuestionمطلوب

typestringمطلوب

promptstringمطلوب

optionsarray of string | nullاختياري

answerstringمطلوب

explanationstringمطلوب

hintstring | nullاختياري

الأخطاء

410application/json

تم إيقاف إصدار API الذي يُجاب عن هذا الطلب به. أرسل إصدارًا مدعومًا في Lingara-Version، أو اربط العميل بإصدار آخر.

4XXapplication/json

رُفض الطلب. يوضّح code السبب، ويشرحه error بالكلمات.

503application/json · text/plain

الخدمة غير متاحة مؤقتًا؛ أعد المحاولة بعد عدد الثواني المذكور في Retry-After. أثناء الصيانة يكون المتن نصًا عاديًا بدلًا من غلاف الخطأ.

5XXapplication/json

رُفض الطلب. يوضّح code السبب، ويشرحه error بالكلمات.

codestringمطلوب

سبب رفض الطلب، في صورة رمز ثابت يمكن التفرّع بناءً عليه: مثل insufficient_scope (403) وrate_limited (429)، ولعميل يُفوتَر بحسب الاستهلاك spend_cap_reached (402) وmetered_billing_inactive (402).

errorstringمطلوب

مثال

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";

تفضّل مكتبة؟ راجع قسم المكتبات.