Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kota requirements API

The requirements API from Kota — 1 operation(s) for requirements.

Kota requirements API is one of 33 APIs that Kota publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include requirements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 1 path, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://test.api.kota.io, https://api.kota.io.

2 operations 1 paths 16 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kota.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kota requirements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

requirements 2
GET
/requirements/{requirement_id}
Get a requirement
get-requirement 2 params → 200400401404500
POST
/requirements/{requirement_id}
Submit answers
submit-answers 2 params body → 200400401404409500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Submit-answersRequestBadRequestError (8 properties), Get-requirementRequestInternalServerError (6 properties), Get-requirementRequestNotFoundError (6 properties), Submit-answersRequestNotFoundError (6 properties). Each schema is shown below with its type and property counts.

Submit-answersRequestInternalServerError
object
6 properties 6 required
RequirementsRequirementIdPostResponsesContentApplicationJsonSchemaSchema
object
The requirement schema with the current cumulative answers injected as field defaults, so the client can render the next step (or confirm completion) without a…
Requirements_get-requirement_Response_200
object
3 properties 1 required
Submit-answersRequestConflictError
object
6 properties 6 required
Get-requirementRequestBadRequestError
object
6 properties 6 required
Submit-answersRequestUnauthorizedError
object
6 properties 6 required
RequirementsRequirementIdPostRequestBodyContentApplicationJsonSchemaAnswers
object
A key-value map of field IDs to answer values.
Requirements_submit-answers_Response_200
object
3 properties 2 required
RequirementsRequirementIdPostResponsesContentApplicationProblemJsonSchemaErrorsItems
object
3 properties 3 required
RequirementsRequirementIdPostResponsesContentApplicationJsonSchemaStatus
string
The derived submission status. "fulfilled" once the cumulative answers satisfy the whole schema; "inprogress" when answers are stored but the schema is not yet…
Submit-answersRequestNotFoundError
object
6 properties 6 required
RequirementsRequirementIdGetResponsesContentApplicationJsonSchemaSchema
object
A JSON Schema object describing the fields required for this requirement. Present for pending requirements and may also be returned for fulfilled requirements.
Get-requirementRequestNotFoundError
object
6 properties 6 required
Get-requirementRequestInternalServerError
object
6 properties 6 required
Get-requirementRequestUnauthorizedError
object
6 properties 6 required
Submit-answersRequestBadRequestError
object
8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-requirements-api-openapi.yml Raw ↑

Other APIs Kota publishes across the network.

Kota Associated Persons API
Kota associatedPersons API
Kota Contribution Reports API
Kota contributionReports API
Kota Dependents Management Intents API
Kota dependentsManagementIntents API
Kota Embed Sessions API
Kota embedSessions API
Kota employees API
Kota employers API
Kota Enrolment Intents API
Kota enrolmentIntents API