API docs by Redocly

IHK Examination API (1.0)

Download OpenAPI specification:

License: Apache-2.0

API for managing IHK examination data to manage provider data and register content

Service Providers

Get service providers

Retrieve a list of registered service providers for a user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new service provider

Register a new service provider in the system

Authorizations:
bearerAuth
Request Body schema: application/json
required
provider_id
required
string <uuid>

Unique identifier for the service provider

name
required
string
contact_email
required
string <email>

Email address for contacting the provider

contact_phone
string
website
string
description
string
creation_date
string <date-time>
last_updated
string <date-time>
authorization_type
string
Enum: "oauth2" "api_token"

Type of authorization required for the provider

authorization_url
string <uri>

URL for the authorization endpoint

spi_base_url
string <uri>

URL to the base endpoint of the service provider interface (SPI)

Responses

Request samples

Content type
application/json
{
  • "provider_id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "string",
  • "contact_email": "user@example.com",
  • "contact_phone": "string",
  • "website": "string",
  • "description": "string",
  • "creation_date": "2019-08-24T14:15:22Z",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "authorization_type": "oauth2",
  • "authorization_url": "http://example.com",
  • "spi_base_url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "provider_id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "string",
  • "contact_email": "user@example.com",
  • "contact_phone": "string",
  • "website": "string",
  • "description": "string",
  • "creation_date": "2019-08-24T14:15:22Z",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "authorization_type": "oauth2",
  • "authorization_url": "http://example.com",
  • "spi_base_url": "http://example.com"
}

Update a service provider data

Update an existing service provider's information

Authorizations:
bearerAuth
path Parameters
provider_id
required
string <uuid>

Unique identifier of the service provider to update

Request Body schema: application/json
provider_id
required
string <uuid>

Unique identifier for the service provider

name
required
string
contact_email
required
string <email>

Email address for contacting the provider

contact_phone
string
website
string
description
string
creation_date
string <date-time>
last_updated
string <date-time>
authorization_type
string
Enum: "oauth2" "api_token"

Type of authorization required for the provider

authorization_url
string <uri>

URL for the authorization endpoint

spi_base_url
string <uri>

URL to the base endpoint of the service provider interface (SPI)

Responses

Request samples

Content type
application/json
{
  • "provider_id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "string",
  • "contact_email": "user@example.com",
  • "contact_phone": "string",
  • "website": "string",
  • "description": "string",
  • "creation_date": "2019-08-24T14:15:22Z",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "authorization_type": "oauth2",
  • "authorization_url": "http://example.com",
  • "spi_base_url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "provider_id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "string",
  • "contact_email": "user@example.com",
  • "contact_phone": "string",
  • "website": "string",
  • "description": "string",
  • "creation_date": "2019-08-24T14:15:22Z",
  • "last_updated": "2019-08-24T14:15:22Z",
  • "authorization_type": "oauth2",
  • "authorization_url": "http://example.com",
  • "spi_base_url": "http://example.com"
}

Content Specification

Define content specification for a provider

Create or update the content specification for a given service provider

Authorizations:
bearerAuth
path Parameters
provider_id
required
string <uuid>

Unique identifier of the service provider

Request Body schema: application/json
required
spec
required
object

TODO The content specification details for the provider

Responses

Request samples

Content type
application/json
{
  • "spec": { }
}

Response samples

Content type
application/json
{
  • "message": "Content specification updated"
}