API docs by Redocly

IOM - Internal API (1.0.0)

Download OpenAPI specification:

IOM - Internal API

Chat

Internal - Chat

setSeen

Set a chat message as seen.

Request Body schema: application/x-www-form-urlencoded
required
chatId
required
integer <int64>
lastSeenId
required
integer <int64>
seenTime
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": null
}

send

Send a chat message.

Request Body schema: application/x-www-form-urlencoded
required
chatId
required
integer <int64>
text
required
string

Responses

Response samples

Content type
application/json
{}

getMessagesBefore

Retrieve all messages that were sent before a specific message.

query Parameters
chatId
required
integer <int64>
Example: chatId=1
lastReceivedId
integer <int64>
Example: lastReceivedId=1
offset
integer <int32>
Example: offset=0
limit
integer <int32>
Example: limit=10

Responses

Response samples

Content type
application/json
{}

getMessages

Retrieve the messages for a specific chat since the last received message.

query Parameters
ChatId
required
integer <int64>
Example: ChatId=1
lastReceivedId
integer <int64>
Example: lastReceivedId=1
offset
integer <int32>
Example: offset=0
limit
integer <int32>
Example: limit=10

Responses

Response samples

Content type
application/json
{}

Client

Internal - Client

requestAccount

Create an account request.

Request Body schema: application/x-www-form-urlencoded
required
email
required
string

E-mail of participant

firstName
required
string

First name of participant

lastName
required
string

Last name of participant

salutation
required
string
Enum: "MISTER" "MISS" "NEUTRAL"
comment
string

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": null
}

checkLogin

Check if login credentials are valid.

Request Body schema: */*
required
string

Responses

Response samples

Content type
application/json
true

login

Login user and set last active to now.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Beta",
  • "lastName": "Tester",
  • "email": "beta.tester@m-pulso.com",
  • "salutation": "NEUTRAL",
  • "academicTitlePrefix": "Dr.",
  • "academicTitleSuffix": "MSc",
  • "additionalInfo": "string",
  • "birthDate": 1493192100000,
  • "language": "en",
  • "profileImage": {},
  • "externalId": "1"
}

registerPushReg

Register the push id for the participant.

Request Body schema: application/x-www-form-urlencoded
required
pushRegId
required
string

Push registration id

Responses

Response samples

Content type
application/json
0
0

registerTrainingParticipant2

Register the participant.

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

Password to set for user (at least 6 characters long, no whitespace)

email
required
string

E-mail of participant

additionalInfo
required
string

Additional info which should be attached to the participant.

firstName
required
string

First name of participant

lastName
required
string

Last name of participant

salutation
required
string
Enum: "MISTER" "MISS" "NEUTRAL"

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

registerTrainingParticipant

Register the participant

Request Body schema: application/x-www-form-urlencoded
required
password
required
string

Password to set for user (at least 6 characters long, no whitespace)

email
required
string

E-mail of participant

additionalInfo
required
string

Additional info which should be attached to the participant.

firstName
required
string

First name of participant

lastName
required
string

Last name of participant

salutation
required
string
Enum: "MISTER" "MISS" "NEUTRAL"

Responses

Response samples

Content type
application/json
0
0

forgotPassword

Resets the password.

Request Body schema: application/x-www-form-urlencoded
required
e-mail
required
string

E-mail of participant

Responses

Response samples

Content type
application/json
0
0

deleteUser

Delete the authenticated training participant.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": null
}

code

Retrieve the QR-Code for the participant.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 300,
  • "returnObject": null
}

registerTrainingParticipantAndSendActivation

Register a training participant and send an activation.

Request Body schema: application/x-www-form-urlencoded
required
email
required
string

E-mail of participant

firstName
required
string

First name of participant

lastName
required
string

Last name of participant

salutation
required
string
Enum: "MISTER" "MISS" "NEUTRAL"
additionalInfo
required
string

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": 1
}

checkGdpr

Check if the GDPR acceptance is present.

query Parameters
bundleId
string
Example: bundleId=1263455225
packageName
string
Example: packageName=com.iom.microtraining.test3
webClientLink
string
Example: webClientLink=https://test3.micro-training.com/

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": true
}

updateGdpr

Update the GDPR acceptance.

Request Body schema: application/x-www-form-urlencoded
required
bundleId
string
packageName
string
webClientLink
string

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": null
}

ClientInfo

Internal - Client Info

getClientInfo

Retrieve the client info texts for the optional app (iosBundleId or androidPackageName) or webclient, otherwise the default texts in the provided language.

query Parameters
iosBundleId
string
Example: iosBundleId=com.m-pulso.com
androidPackageName
string
Example: androidPackageName=com.microtraining
webClientLink
string
Example: webClientLink=https://micro-training.com
iso2
string
Example: iso2=en

Responses

Response samples

Content type
application/json
{}

Duel

Internal - Duel

getDuelMode

Retrieve the duel mode

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": "CLASSIC"
}

getPossibleOpponents

Retrieve challengeable training participants for the specified training.

query Parameters
trainingId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

createChallenge

Create a challenge between the logged in user and the provided training participant for the training.

Request Body schema: application/x-www-form-urlencoded
required
trainingId
required
integer <int64>
opponentId
integer <int64>

if instance uses anonymous duels -> omit

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

getAllForTraining

Retrieve all duels for a specific training.

query Parameters
trainingId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

getChallenge

Retrieve a specific duel.

query Parameters
challengeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

acceptChallenge

Accept an open challenge.

Request Body schema: application/x-www-form-urlencoded
required
challengeId
required
integer <int64>
pin
integer <int32>

necessary if instance uses anonymous duels

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

declineChallenge

Decline an open challenge.

Request Body schema: application/x-www-form-urlencoded
required
challengeId
required
integer <int64>
pin
integer <int32>

necessary if instance uses anonymous duels

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": { }
}

sendResult

Process the result for a round in an active duel.

Request Body schema: application/x-www-form-urlencoded
required
roundId
required
integer <int64>
correctCount
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

Training

Internal - Training

setLearningCardProgress

Update the learning card progress.

Request Body schema: */*
required
Array
learningCardProgressId
integer <int64>
correctAnswerCount
integer <int32>
falseAnswerCount
integer <int32>
consecutiveCorrectAnswerCount
integer <int32>
updateTime
integer <int64>

Responses

Response samples

Content type
application/json
{}

setExamResult

Add a single exam result.

Request Body schema: application/x-www-form-urlencoded
required
trainingId
required
integer <int64>
percentage
required
number <float>
timeStamp
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": null
}

setExamResults

Add multiple exam results.

Request Body schema: */*
required
Array
trainingId
integer <int64>
completionTime
integer <int64>
percentage
number <float>
Array of objects (DTOFinalExamLearningCardHistoryEvent)

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

getNextQuestion

Retrieve the next learning card to learn.

query Parameters
progressGroupId
required
integer <int64>
Example: progressGroupId=1
lastQuestionId
integer <int64>
Example: lastQuestionId=1

Responses

Response samples

Content type
application/json
{}

getAnyQuestion

Retrieve the next learning card to learn for open learning.

query Parameters
trainingId
required
integer <int64>
lastQuestionId
integer <int64>
Example: lastQuestionId=1

Responses

Response samples

Content type
application/json
{}

getTraining

Retrieve a specific training progress.

query Parameters
trainingProgressId
required
integer <int64>
Example: trainingProgressId=1

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

getTrainingProgress

Retrieve all training progresses where signature is not required

query Parameters
searchString
any
tagIds
Array of strings <uuid> [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

checkSignatureRequirement

Check if a signature is required for the training and not given by the current user.

path Parameters
id
required
integer <int64>

ID of the training.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": true
}

setTrainingUserSignature

Sets a signature for a training participant by uploading an image file, associating it with the specified training ID.

path Parameters
id
required
integer <int64>

ID of the training.

Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Beta",
  • "lastName": "Tester",
  • "email": "beta.tester@m-pulso.com",
  • "salutation": "NEUTRAL",
  • "academicTitlePrefix": "Dr.",
  • "academicTitleSuffix": "MSc",
  • "additionalInfo": "string",
  • "birthDate": 1493192100000,
  • "language": "en",
  • "profileImage": {},
  • "externalId": "1"
}

Profile

Internal - Profile

getParticipant

Retrieve the profile of the training participant.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

updateParticipant

Update the profile of the training participant.

Request Body schema: multipart/form-data
firstName
string

First name of participant

lastName
string

Last name of participant

salutation
string
Enum: "MISTER" "MISS" "NEUTRAL"
birthdate
integer <int64>

Birth date in milliseconds since January 1, 1970 00:00:00. If not set, current value will be cleared

picture
string <binary>

Profile picture of participant

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

deleteProfilePicture

Delete the profile picture of the training participant.

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

updateProfilePicture

Update the profile picture of the training participant.

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

Resource

Internal - Resource

getResource

path Parameters
fileName
required
string
Example: resource.jpg

Responses

Statistics

Internal - Statistics

getStatisticsForTraining

Retrieve the statistics for a specific training.

query Parameters
trainingId
required
integer <int64>
Example: trainingId=1

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": {
    }
}

getStatisticsForUser

Retrieve the statistics for all trainings.

query Parameters
participantId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "resultCode": 0,
  • "returnObject": [
    ]
}

System

Internal - System

versionName

Responses

Response samples

Content type
application/json
"string"

time

Responses

Response samples

Content type
application/json
"string"

languages

Responses

Response samples

Content type
application/json
[
  • "string"
]

Tracking

Internal - Tracking

addTrainingLearningCardHistoryEvent

Create history events and update the learning card progress.

Request Body schema: */*
required
Array
learningCardProgressId
integer <int64>
startTime
integer <int64>
duration
integer <int64>
correct
boolean

Responses

Response samples

Content type
application/json
true

Trigger

Internal - Trigger

prepareTrainings

Responses

Response samples

Content type
application/json
true

triggetCertificateGeneration

Responses

Response samples

Content type
application/json
true

fixImports

Responses

Response samples

Content type
application/json
0
0