Een lesplan ophalen

Parameters

Lingara-Versionheaderstringoptioneel

De API-versie waaronder dit verzoek wordt beantwoord. Zonder deze krijgt een toegangstoken de versie waaraan zijn client is gekoppeld, en een verzoek zonder token de huidige versie. De versie die nog in ontwikkeling is, bereik je alleen door die hier te noemen. Een onbekende versie geeft 400 met code api_version_unknown. GET /v1/versions toont de versies.

idpathstringverplicht

Antwoorden

200 Het lesplan

idstringverplicht

statusPlanStatusverplicht

titlestring | nulloptioneel

source_langstringverplicht

target_langstringverplicht

levelintegerverplicht

created_atstringverplicht

completed_atstring | nulloptioneel

ai_generatedbooleanverplicht

contentLessonPlanContent | nulloptioneel

introductionstring | nulloptioneel

learning_objectivesarray of stringverplicht

vocabularyarray of PlanWordverplicht

wordstringverplicht

pronunciationstring | nulloptioneel

translationstringverplicht

setsarray of PlanSetverplicht

numberintegerverplicht

contextstring | nulloptioneel

questionsarray of PlanQuestionverplicht

typestringverplicht

promptstringverplicht

optionsarray of string | nulloptioneel

answerstringverplicht

explanationstringverplicht

hintstring | nulloptioneel

Fouten

410application/json

De API-versie waaronder dit verzoek wordt beantwoord, is stopgezet. Stuur een ondersteunde versie mee in Lingara-Version, of koppel de client aan een andere versie.

4XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

503application/json · text/plain

De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop.

5XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

codestringverplicht

Waarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld insufficient_scope (403), rate_limited (429) en, voor een client met verbruiksafrekening, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplicht

Voorbeeld

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

Liever een bibliotheek? Zie de sectie Bibliotheken.