Toggle navigation

API Webservice - Learning Management System

Version 1.0.0

This documentation has been created to explain the function and methods of our API-Webservice. The API-Webservice can be used to interact from a 3th party system to get, update and create data in our systems.

Version: 1.0

Status: Live

Prepared by:

Yahya Orak

contact: support@8solutions.de

Date issued: 28.07.2019

Access

The Live and UAT-System will be publically accessible. The access to our systems are protected with an API-Token, each key is a unique identifier. The access credentials will be sent to the partners once access has been approved by an super administrator.

Headers / Methods / Security

Server: Apache

Cache-Control: no-store, no-cache, must-revalidate

Pragma: no-cache

Protocol: https, h2

Strict-Transport-Security: max-age=31536000

Cetificate: RSA 4096 bits (SHA256withRSA)

Content-Type: application/json; charset=utf-8

Methods: POST

Security

token=your-token-key

Domains used by our systems

Live: https://portal.aus-schulung.de

UAT: https://demo.aus-schulung.de

Basic Information

Base URL:

https://portal.aus-schulung.de/all/user/

Where to find my tocken?

The API-Tocken will be provided by our system administrator. Please get in touch with us to receive your personal company tocken.

Employee Accounts - INSERT

USER APIs

1.create

  • Request
    • Format
METHOD POST
URL / create_employee
    • Parameters
. token
. user information.
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,
     “user_type”: “Employee”,
     “first_name”: “Max”,
       “last_name”: “Mustermann”,
     “email”: “max.mustermann@8solutions.de”,
      “birthday”: “1991-09-12”,   
      “status”: “Active”,
      “picture”: “/uploads/users/photo”,
…}

 

  • Response
    • Format
code Http response code
msg Message in case of failure
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘
}

Employee Accounts - UPDATE

2.update

  • Request
    • Format
METHOD POST
URL / update_employee
    • Parameters
. token
. user information.
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,
“id”: 1,
“user_type”: “Employee”,
     “first_name”: “Max”,
       “last_name”: “Mustermann”,
     “email”: “max.mustermann@8solutions.de”,
      “birthday”: “1991-09-12”,   
      “status”: “Active”,
      “picture”: “/uploads/users/photo”,
…}

 

  • Response
    • Format
code Http response code
msg Message in case of failure
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘, ‚User not exist‘, ‚You do not have permission.‘
}

Employee Accounts - GET

3.read

  • Request
    • Format
METHOD POST
URL /read_employee
    • Parameters
. token
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,}

 

  • Response
    • Format
  code Http response code  
  msg Message in case of failure  
  data                                        user list
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
“data”: list of user data
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘}

Training Statistics - GET

Read training.
Request

    • Format
METHOD POST
URL /read_topicList
    • Parameters
. token
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,}

 

  • Response
    • Format
  code Http response code  
  msg Message in case of failure  
  data                                         List of Topic
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
“data”:  topic data
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘}

Read exam.
Request

    • Format
METHOD POST
URL / read_examList
    • Parameters
. token
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,}

 

  • Response
    • Format
  code Http response code  
  msg Message in case of failure  
  data                                         exam list
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
“data”: exam list
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘}

Exam Statistics - GET

Request

    • Format
METHOD POST
URL / read_examList
    • Parameters
. token
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,}

 

  • Response
    • Format
  code Http response code  
  msg Message in case of failure  
  data                                         exam list
    • Successful Case
  • If request API token is valid.
{
“code”:  200 ,
“msg”:  “Success”,
“data”: exam list
}
    • Failure Case
  • If  requested user has not API access or expired
{
“code”:  403 ,
“msg”:  “There is no token.”, ‚The token is invalid‘}