Zum Hauptinhalt springen
API docs by Redocly

Vidis REST (v1.0)

Download OpenAPI specification:Download

License: Apache 2.0

Vidis REST API

EducationProvider

getSchools

List all schools, that has activated any of the owned offers.

query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getOffersBySchool

List all owned offers, that has activated by the selected school.

path Parameters
organizationId
required
string
query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getActivations

List all the activation details for all owned offer.

query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getOffers

List all owned offers, that has activated by any schools.

query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getSchoolsByOffer

List all schools, that has activated the selected owned offer.

path Parameters
offerId
required
string
query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getActivationByOfferAndSchool

List the activation details for a selected owned offer, that has activated by the selected school.

path Parameters
offerId
required
string
organizationId
required
string

Responses

Response samples

Content type
{
  • "activationUserEmail": "string",
  • "generatedAVVLink": "string",
  • "offerId": 0,
  • "offerTitle": "string",
  • "organizationId": 0,
  • "organizationName": "string",
  • "schoolNameFromIdm": "string",
  • "schoolNumber": "string",
  • "x-class-name": "hu.webtown.liferay.vidis.rest.dto.v1_0.ActivationDTO"
}

getActivationBySchoolAndOffer

List the activation details for a selected school, that has activated the selected owned offer.

path Parameters
organizationId
required
string
offerId
required
string

Responses

Response samples

Content type
{
  • "activationUserEmail": "string",
  • "generatedAVVLink": "string",
  • "offerId": 0,
  • "offerTitle": "string",
  • "organizationId": 0,
  • "organizationName": "string",
  • "schoolNameFromIdm": "string",
  • "schoolNumber": "string",
  • "x-class-name": "hu.webtown.liferay.vidis.rest.dto.v1_0.ActivationDTO"
}

IDMBetreiber

getAllOffers

List all offers.

query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getActivatedOffersBySchool

List all offers, that has activated by the selected school.

path Parameters
schoolName
required
string
query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getActivatedOffersByRegion

List all offers, that has activated by any schools in the selected region.

path Parameters
regionName
required
string
query Parameters
page
string
pageSize
string

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "lastPage": 0,
  • "totalCount": 0,
  • "pageSize": 0,
  • "actions": {
    },
  • "page": 0,
  • "facets": [
    ]
}

getOpenAPI

path Parameters
type
required
string

Responses