MENU navbar-image

Introduction

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

Authenticating requests

This API is not authenticated.

Buildings

Create

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/buildings';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ybbznrzyugutj',
            'address' => 'voluptatum',
            'observations' => 'harum',
            'imageId' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/buildings"
);

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

let body = {
    "name": "ybbznrzyugutj",
    "address": "voluptatum",
    "observations": "harum",
    "imageId": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST buildings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: ybbznrzyugutj

address   string  optional  

Example: voluptatum

observations   string  optional  

Example: harum

imageId   string  optional  

Example: architecto

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/buildings/search';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'offset' => 20,
            'limit' => 9,
            'searchTerm' => 'quidem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/buildings/search"
);

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

let body = {
    "offset": 20,
    "limit": 9,
    "searchTerm": "quidem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Details

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/buildings/16';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/buildings/16"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Server Error"
}
 

Request      

GET buildings/{building_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

building_id   integer   

The ID of the building. Example: 16

Update

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/buildings/12';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'vxakvnsupkmofy',
            'address' => 'qui',
            'observations' => 'nihil',
            'imageId' => 'sed',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/buildings/12"
);

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

let body = {
    "name": "vxakvnsupkmofy",
    "address": "qui",
    "observations": "nihil",
    "imageId": "sed"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT buildings/{building_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

building_id   integer   

The ID of the building. Example: 12

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vxakvnsupkmofy

address   string  optional  

Example: qui

observations   string  optional  

Example: nihil

imageId   string  optional  

Example: sed

Delete

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/buildings/6';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/buildings/6"
);

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

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE buildings/{building_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

building_id   integer   

The ID of the building. Example: 6

Endpoints

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/sanctum/csrf-cookie';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/sanctum/csrf-cookie"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

GET _ignition/health-check

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/_ignition/health-check';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/_ignition/health-check"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "message": ""
}
 

Request      

GET _ignition/health-check

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST _ignition/execute-solution

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/_ignition/execute-solution';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'solution' => 'incidunt',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/_ignition/execute-solution"
);

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

let body = {
    "solution": "incidunt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST _ignition/execute-solution

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

solution   string   

Example: incidunt

parameters   object  optional  

POST _ignition/update-config

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/_ignition/update-config';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'theme' => 'light',
            'editor' => 'odit',
            'hide_solutions' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/_ignition/update-config"
);

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

let body = {
    "theme": "light",
    "editor": "odit",
    "hide_solutions": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST _ignition/update-config

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

theme   string   

Example: light

Must be one of:
  • light
  • dark
  • auto
editor   string   

Example: odit

hide_solutions   boolean   

Example: false

POST rooms/export

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/export';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'offset' => 10,
            'limit' => 14,
            'searchTerm' => 'occaecati',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/export"
);

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

let body = {
    "offset": 10,
    "limit": 14,
    "searchTerm": "occaecati"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rooms/export

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

offset   integer  optional  

Example: 10

limit   integer  optional  

Example: 14

searchTerm   string  optional  

Example: occaecati

filters   object[]  optional  
order   object[]  optional  

Handle the incoming request.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/health';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/health"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Server Error"
}
 

Request      

GET health

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Facilities

Find all facilities

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/facilities';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/facilities"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
 

{
    "errorMessage": "messages.unauthorized"
}
 

Request      

GET facilities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Create

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/facilities';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ocwgqfwasg',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/facilities"
);

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

let body = {
    "name": "ocwgqfwasg"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST facilities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: ocwgqfwasg

Room Types

Find all room type

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/types"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
 

{
    "errorMessage": "messages.unauthorized"
}
 

Request      

GET rooms/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Creaate

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/types';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ssrvdtrdnj',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/types"
);

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

let body = {
    "name": "ssrvdtrdnj"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rooms/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: ssrvdtrdnj

Rooms

Create

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'buildingId' => 'assumenda',
            'facultyId' => 1,
            'name' => 'abkjlkew',
            'abbreviation' => 'hbcz',
            'typeId' => 11,
            'maxSeatsNo' => 15,
            'floor' => 245292141.8,
            'observations' => 'vero',
            'imageId' => 'debitis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms"
);

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

let body = {
    "buildingId": "assumenda",
    "facultyId": 1,
    "name": "abkjlkew",
    "abbreviation": "hbcz",
    "typeId": 11,
    "maxSeatsNo": 15,
    "floor": 245292141.8,
    "observations": "vero",
    "imageId": "debitis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST rooms

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

buildingId   string   

Example: assumenda

facultyId   integer  optional  

Example: 1

name   string   

Must not be greater than 255 characters. Example: abkjlkew

abbreviation   string   

Must not be greater than 255 characters. Example: hbcz

typeId   integer   

Example: 11

maxSeatsNo   number  optional  

Must be at least 0. Example: 15

floor   number  optional  

Example: 245292141.8

observations   string  optional  

Example: vero

imageId   string  optional  

Example: debitis

facilities   object[]  optional  

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/search';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'offset' => 9,
            'limit' => 18,
            'searchTerm' => 'quisquam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/search"
);

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

let body = {
    "offset": 9,
    "limit": 18,
    "searchTerm": "quisquam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Details

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/15';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/15"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Server Error"
}
 

Request      

GET rooms/{room_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room_id   integer   

The ID of the room. Example: 15

Update

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/17';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'buildingId' => 'ex',
            'facultyId' => 14,
            'name' => 'cepdrvbdhugbgpbwgxyvzk',
            'abbreviation' => 'ikhdetgouyti',
            'typeId' => 3.44963507,
            'maxSeatsNo' => 67,
            'floor' => 1022.0,
            'observations' => 'laboriosam',
            'imageId' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/17"
);

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

let body = {
    "buildingId": "ex",
    "facultyId": 14,
    "name": "cepdrvbdhugbgpbwgxyvzk",
    "abbreviation": "ikhdetgouyti",
    "typeId": 3.44963507,
    "maxSeatsNo": 67,
    "floor": 1022,
    "observations": "laboriosam",
    "imageId": "ut"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT rooms/{room_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room_id   integer   

The ID of the room. Example: 17

Body Parameters

buildingId   string   

Example: ex

facultyId   integer  optional  

Example: 14

name   string   

Must not be greater than 255 characters. Example: cepdrvbdhugbgpbwgxyvzk

abbreviation   string   

Must not be greater than 255 characters. Example: ikhdetgouyti

typeId   number   

Example: 3.44963507

maxSeatsNo   number  optional  

Must be at least 0. Example: 67

floor   number  optional  

Example: 1022

observations   string  optional  

Example: laboriosam

imageId   string  optional  

Example: ut

facilities   object[]  optional  

Delete

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/10';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/10"
);

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

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE rooms/{room_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room_id   integer   

The ID of the room. Example: 10

Export

Example request:
$client = new \GuzzleHttp\Client();
$url = 'http://localhost/rooms/export/8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "http://localhost/rooms/export/8"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Server Error"
}
 

Request      

GET rooms/export/{exportParams_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

exportParams_id   integer   

The ID of the exportParams. Example: 8