Λήψη σχεδίου μαθήματος

Παράμετροι

Lingara-Versionheaderstringπροαιρετικό

Η έκδοση API με την οποία απαντάται αυτό το αίτημα. Χωρίς αυτήν, ένα token πρόσβασης παίρνει την έκδοση στην οποία είναι δεσμευμένος ο πελάτης του και ένα αίτημα χωρίς token παίρνει την τρέχουσα έκδοση. Η έκδοση που βρίσκεται ακόμη υπό ανάπτυξη είναι προσβάσιμη μόνο αν την ονομάσετε εδώ. Μια άγνωστη έκδοση απαντάται με 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";

Προτιμάτε μια βιβλιοθήκη; Δείτε την ενότητα Βιβλιοθήκες.