MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include a X-API-KEY header with the value "{YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Schedule

APIs for managing schedule

Create Schedule

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/test/schedule" \
    --header "X-API-KEY: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unit\": 1,
    \"company\": 1,
    \"division\": 1,
    \"position\": 1,
    \"level\": 1
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/test/schedule"
);

const headers = {
    "X-API-KEY": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unit": 1,
    "company": 1,
    "division": 1,
    "position": 1,
    "level": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'http://127.0.0.1:8000/api/v1/test/schedule';
$response = $client->post(
    $url,
    [
        'headers' => [
            'X-API-KEY' => '{YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'unit' => 1.0,
            'company' => 1.0,
            'division' => 1.0,
            'position' => 1.0,
            'level' => 1.0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/test/schedule

Headers

X-API-KEY        

Example: {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

unit   number  optional    

unit id. Example: 1

company   number  optional    

company id. Example: 1

division   number  optional    

division id. Example: 1

position   number  optional    

position id. Example: 1

level   number  optional    

level id. Example: 1