Toggle navigation

API Webservice - Learning Management System

Version 1.0.0

API Webservice for our SaaS Learning Management System

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.

USER APIs

1.create

  • Request
    • Format
METHODPOST
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
codeHttp response code
msgMessage 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‘
}

2.update

  • Request
    • Format
METHODPOST
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
codeHttp response code
msgMessage 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.‘
}

3.read

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

 

  • Response
    • Format
 codeHttp response code 
 msgMessage 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‘}

Read training.
Request

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

 

  • Response
    • Format
 codeHttp response code 
 msgMessage 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
METHODPOST
URL/ read_examList
    • Parameters
. token
    • Example
{
 “token”: “c16497f0e18bd0f629a6acd3fd0f297f”,}

 

  • Response
    • Format
 codeHttp response code 
 msgMessage 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‘}

Request

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

 

  • Response
    • Format
 codeHttp response code 
 msgMessage 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‘}