NAV
shell javascript

Information

Welcome to the AAC Education API reference.

Here you can find api calls for your application for using the EDU API.

The EDUAPI utilized JWT authentication and header tokens. Generate a token by providing a valid AAC email address and password to /api/authenticate. A token will be generated, and it should be passed in the header of your subseqent api calls.

Users

Search for User

Required: JSONAPI formatted object

Example request:

curl "http://127.0.0.1/api/v1/users/search" \
-H "Accept: application/json" \
    -d "data.type"="corporis" \
    -d "data.attributes.field"="corporis" \
    -d "data.attributes.keyword"="corporis" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/users/search",
    "method": "POST",
    "data": {
        "data.type": "corporis",
        "data.attributes.field": "corporis",
        "data.attributes.keyword": "corporis"
},
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

HTTP Request

POST api/v1/users/search

Parameters

Parameter Type Status Description
data.type string required Maximum: 255
data.attributes.field string required Maximum: 255
data.attributes.keyword string required Maximum: 255

Get Specific User

Example request:

curl "http://127.0.0.1/api/v1/users/{users}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/users/{users}",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/users/{users}

HEAD api/v1/users/{users}

Users' Klasses (Classes)

Get All Users' Skills

Required: User ID

Example request:

curl "http://127.0.0.1/api/v1/users/{users}/skills" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/users/{users}/skills",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/users/{users}/skills

HEAD api/v1/users/{users}/skills

Klass (Classes)

Get All Classes

Required: Provider ID

Example request:

curl "http://127.0.0.1/api/v1/klasses" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/klasses",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/klasses

HEAD api/v1/klasses

Create New Class

Example request:

curl "http://127.0.0.1/api/v1/klasses" \
-H "Accept: application/json" \
    -d "data.type"="perferendis" \
    -d "data.attributes.name"="perferendis" \
    -d "data.attributes.code"="perferendis" \
    -d "data.attributes.provider_id"="5" \
    -d "data.attributes.date"="perferendis" \
    -d "data.attributes.desc"="perferendis" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/klasses",
    "method": "POST",
    "data": {
        "data.type": "perferendis",
        "data.attributes.name": "perferendis",
        "data.attributes.code": "perferendis",
        "data.attributes.provider_id": 5,
        "data.attributes.date": "perferendis",
        "data.attributes.desc": "perferendis"
},
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

HTTP Request

POST api/v1/klasses

Parameters

Parameter Type Status Description
data.type string required Maximum: 255
data.attributes.name string required Maximum: 255
data.attributes.code string required Maximum: 255
data.attributes.provider_id integer required
data.attributes.date string required
data.attributes.desc string required

Get Specific Class

Required: Class ID

Example request:

curl "http://127.0.0.1/api/v1/klasses/{klasses}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/klasses/{klasses}",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/klasses/{klasses}

HEAD api/v1/klasses/{klasses}

Edit Specific Class

Example request:

curl "http://127.0.0.1/api/v1/klasses/{klasses}" \
-H "Accept: application/json" \
    -d "data.type"="vero" \
    -d "data.attributes.name"="vero" \
    -d "data.attributes.code"="vero" \
    -d "data.attributes.provider_id"="92309297" \
    -d "data.attributes.date"="vero" \
    -d "data.attributes.desc"="vero" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/klasses/{klasses}",
    "method": "PUT",
    "data": {
        "data.type": "vero",
        "data.attributes.name": "vero",
        "data.attributes.code": "vero",
        "data.attributes.provider_id": 92309297,
        "data.attributes.date": "vero",
        "data.attributes.desc": "vero"
},
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

HTTP Request

PUT api/v1/klasses/{klasses}

PATCH api/v1/klasses/{klasses}

Parameters

Parameter Type Status Description
data.type string required Maximum: 255
data.attributes.name string required Maximum: 255
data.attributes.code string required Maximum: 255
data.attributes.provider_id integer required
data.attributes.date string required
data.attributes.desc string required

Delete Specific Class

Example request:

curl "http://127.0.0.1/api/v1/klasses/{klasses}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/klasses/{klasses}",
    "method": "DELETE",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

HTTP Request

DELETE api/v1/klasses/{klasses}

Providers' Users

Get All Providers' Users

Required: Provider ID

Example request:

curl "http://127.0.0.1/api/v1/providers/{providers}/users" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/providers/{providers}/users",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/providers/{providers}/users

HEAD api/v1/providers/{providers}/users

Providers

Get Specific Provider

Required: Provider ID

Example request:

curl "http://127.0.0.1/api/v1/providers/{providers}" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/providers/{providers}",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/providers/{providers}

HEAD api/v1/providers/{providers}

Providers' Klasses (Classes)

Get All Providers' Classes

Required: Provider ID

Example request:

curl "http://127.0.0.1/api/v1/providers/{providers}/klasses" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/v1/providers/{providers}/klasses",
    "method": "GET",
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Example response:

null

HTTP Request

GET api/v1/providers/{providers}/klasses

HEAD api/v1/providers/{providers}/klasses

JWT Authentication

Get JWT Token

Example request:

curl "http://127.0.0.1/api/authenticate" \
-H "Accept: application/json" \
    -d "email"="aut" \
    -d "password"="aut" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://127.0.0.1/api/authenticate",
    "method": "POST",
    "data": {
        "email": "aut",
        "password": "aut"
},
        "headers": {
    "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

HTTP Request

POST api/authenticate

Parameters

Parameter Type Status Description
email string required
password string required