Sign in
Docs
API referenceCases

API reference

Approve lessons

Have a token? Manage tokens in the console
POST
/v1/cases/studies/{study_id}/lessons/approve

A person approves the drafted lessons; this writes a study version naming the approver.

Needs scope cases:write.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

study_id*string

The study's id, stu_ and 32 hex characters, from List studies.

Request Body

iohr.cases.v1.ApproveLessonsRequest; path variables override their fields

application/json
  1. body

iohr.cases.v1.ApproveLessonsRequest

base_version?integer
Formatint32
study_id?string

Response Body

iohr.cases.v1.ApproveLessonsResponse

application/json
  1. response

iohr.cases.v1.ApproveLessonsResponse

lessons?

iohr.cases.v1.Lessons

study?

iohr.cases.v1.Study

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.cases.approveLessons("<study_id>", {});  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "lessons": {    "approved_at": "string",    "approved_by": "string",    "approved_version": 0,    "drafted_at": "string",    "drafted_by": "string",    "label": "string",    "lessons": [      {        "correction_id": "string",        "evidence": [          "string"        ],        "text": "string"      }    ],    "markdown": "string",    "state": "string",    "study_id": "string"  },  "study": {    "company": "string",    "created_at": "string",    "created_by": "string",    "current_version": 0,    "date": "string",    "plan_id": "string",    "slug": "string",    "status": "string",    "study_id": "string",    "text": {      "en": {        "markdown": "string",        "summary": "string",        "title": "string"      },      "hr": {        "markdown": "string",        "summary": "string",        "title": "string"      }    },    "updated_at": "string",    "website": "string"  }}