Hae tuntisuunnitelma

Parametrit

Lingara-Versionheaderstringvalinnainen

API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan 400 koodilla api_version_unknown. GET /v1/versions luettelee versiot.

idpathstringpakollinen

Vastaukset

200 Tuntisuunnitelma

idstringpakollinen

statusPlanStatuspakollinen

titlestring | nullvalinnainen

source_langstringpakollinen

target_langstringpakollinen

levelintegerpakollinen

created_atstringpakollinen

completed_atstring | nullvalinnainen

ai_generatedbooleanpakollinen

contentLessonPlanContent | nullvalinnainen

introductionstring | nullvalinnainen

learning_objectivesarray of stringpakollinen

vocabularyarray of PlanWordpakollinen

wordstringpakollinen

pronunciationstring | nullvalinnainen

translationstringpakollinen

setsarray of PlanSetpakollinen

numberintegerpakollinen

contextstring | nullvalinnainen

questionsarray of PlanQuestionpakollinen

typestringpakollinen

promptstringpakollinen

optionsarray of string | nullvalinnainen

answerstringpakollinen

explanationstringpakollinen

hintstring | nullvalinnainen

Virheet

410application/json

API-versio, jolla tähän pyyntöön vastataan, on lopetettu. Lähetä tuettu versio Lingara-Version-otsakkeessa tai kiinnitä asiakas toiseen versioon.

4XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

503application/json · text/plain

Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan.

5XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

codestringpakollinen

Miksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi insufficient_scope (403), rate_limited (429) ja käytön mukaan laskutettavalle asiakkaalle spend_cap_reached (402) ja metered_billing_inactive (402).

errorstringpakollinen

Esimerkki

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

Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.