MENU navbar-image

Introduction

Welcome to the api documentation

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

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

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

Coduri QR

APIs for managing QR codes

Display subdomain's QR code.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/subdomain/qr" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/subdomain/qr"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
x-ratelimit-limit: 240
x-ratelimit-remaining: 238
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Server Error"
}
 

Request      

GET api/v1/subdomain/qr

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Facturi

APIs for managing invoices

Display a listing of invoices.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/invoices?filter[date_start]=velit&filter[date_end]=ipsam&filter[owner_invoice_profile_id]=iusto&filter[invoice_series_id]=aut&filter[number]=impedit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\"
    },
    \"records_number\": 23
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoices"
);

const params = {
    "filter[date_start]": "velit",
    "filter[date_end]": "ipsam",
    "filter[owner_invoice_profile_id]": "iusto",
    "filter[invoice_series_id]": "aut",
    "filter[number]": "impedit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "date_start": "2024-02-23",
        "date_end": "2024-02-23"
    },
    "records_number": 23
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/invoices

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[date_start]   string  optional  

Field to filter by start date. Example: velit

filter[date_end]   string  optional  

Field to filter by end date. Example: ipsam

filter[owner_invoice_profile_id]   string  optional  

Field to filter by owner invoice profile. Example: iusto

filter[ownerInvoiceProfile.owner_id]   string  optional  

Field to filter by owner. Example: dolor

filter[invoice_series_id]   string  optional  

Field to filter by invoice series. Example: aut

filter[number]   string  optional  

Field to filter by number. Example: impedit

Body Parameters

filter   object  optional  
date_start   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2024-02-23

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 23

Store a newly created invoice.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/invoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_series_id\": \"doloremque\",
    \"date\": \"2024-02-23\",
    \"brand_invoice_profile_id\": \"est\",
    \"owner_invoice_profile_id\": \"eum\",
    \"sessions_ids\": [
        1
    ]
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoices"
);

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

let body = {
    "invoice_series_id": "doloremque",
    "date": "2024-02-23",
    "brand_invoice_profile_id": "est",
    "owner_invoice_profile_id": "eum",
    "sessions_ids": [
        1
    ]
};

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

Example response (200):

{
    "data": {
        "id": null,
        "date": null,
        "number": null,
        "user_id": null,
        "invoice_series_id": null,
        "brand_invoice_profile_id": null,
        "brand_invoice_profile_name": null,
        "brand_invoice_profile_fiscal_code": null,
        "brand_invoice_profile_chamber_of_commerce_code": null,
        "brand_invoice_profile_city": null,
        "brand_invoice_profile_phone_fax": null,
        "brand_invoice_profile_mobile1": null,
        "brand_invoice_profile_mobile2": null,
        "brand_invoice_profile_email1": null,
        "brand_invoice_profile_email2": null,
        "brand_invoice_profile_website": null,
        "brand_invoice_profile_bank": null,
        "brand_invoice_profile_bank_account": null,
        "owner_invoice_profile_id": null,
        "owner_invoice_profile_name": null,
        "owner_invoice_profile_fiscal_code": null,
        "owner_invoice_profile_chamber_of_commerce_code": null,
        "owner_invoice_profile_city": null,
        "owner_invoice_profile_phone_fax": null,
        "owner_invoice_profile_mobile1": null,
        "owner_invoice_profile_mobile2": null,
        "owner_invoice_profile_email1": null,
        "owner_invoice_profile_email2": null,
        "owner_invoice_profile_website": null,
        "owner_invoice_profile_bank": null,
        "owner_invoice_profile_bank_account": null,
        "value_with_vat": null,
        "vat_value": null,
        "value_without_vat": "0.0000",
        "invoice_services": null
    }
}
 

Request      

POST api/v1/invoices

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

invoice_series_id   string   

Example: doloremque

date   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

brand_invoice_profile_id   string   

Example: est

owner_invoice_profile_id   string   

Example: eum

sessions_ids   integer[]   

Display an invoice.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/invoices/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoices/13"
);

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

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

Example response (200):

{
    "data": {
        "id": null,
        "date": null,
        "number": null,
        "user_id": null,
        "invoice_series_id": null,
        "brand_invoice_profile_id": null,
        "brand_invoice_profile_name": null,
        "brand_invoice_profile_fiscal_code": null,
        "brand_invoice_profile_chamber_of_commerce_code": null,
        "brand_invoice_profile_city": null,
        "brand_invoice_profile_phone_fax": null,
        "brand_invoice_profile_mobile1": null,
        "brand_invoice_profile_mobile2": null,
        "brand_invoice_profile_email1": null,
        "brand_invoice_profile_email2": null,
        "brand_invoice_profile_website": null,
        "brand_invoice_profile_bank": null,
        "brand_invoice_profile_bank_account": null,
        "owner_invoice_profile_id": null,
        "owner_invoice_profile_name": null,
        "owner_invoice_profile_fiscal_code": null,
        "owner_invoice_profile_chamber_of_commerce_code": null,
        "owner_invoice_profile_city": null,
        "owner_invoice_profile_phone_fax": null,
        "owner_invoice_profile_mobile1": null,
        "owner_invoice_profile_mobile2": null,
        "owner_invoice_profile_email1": null,
        "owner_invoice_profile_email2": null,
        "owner_invoice_profile_website": null,
        "owner_invoice_profile_bank": null,
        "owner_invoice_profile_bank_account": null,
        "value_with_vat": null,
        "vat_value": null,
        "value_without_vat": "0.0000",
        "invoice_services": null
    }
}
 

Request      

GET api/v1/invoices/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the invoice. Example: 13

invoice   integer   

Example: 5

Generate invoice's PDF document.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/invoices/4/generate-pdf" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoices/4/generate-pdf"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/invoices/{invoice_id}/generate-pdf

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice_id   integer   

The ID of the invoice. Example: 4

Facturi serii

APIs for managing invoice series

Display invoice series dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/invoice-series/dropdown-values" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoice-series/dropdown-values"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/invoice-series/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Create invoice serie

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/invoice-series" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"series\": \"ftlgeqyuepesjwlaaylilju\",
    \"brand_invoice_profile_id\": 16,
    \"start_no\": 15,
    \"active\": false,
    \"currency\": \"EUR\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoice-series"
);

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

let body = {
    "series": "ftlgeqyuepesjwlaaylilju",
    "brand_invoice_profile_id": 16,
    "start_no": 15,
    "active": false,
    "currency": "EUR"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/invoice-series

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

series   string   

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Must be at least 1 character. Example: ftlgeqyuepesjwlaaylilju

brand_invoice_profile_id   integer   

Example: 16

start_no   integer   

Example: 15

active   boolean   

Example: false

currency   string  optional  

Must be one of EUR. Example: EUR

Display invoice series

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/invoice-series/id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoice-series/id"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/invoice-series/{brand_invoice_profile_id?}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand_invoice_profile_id   string  optional  

The ID of the brand invoice profile. Example: id

Activate invoice serie

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/invoice-series/activate/velit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/invoice-series/activate/velit"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/invoice-series/activate/{invoice_series}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice_series   string   

Example: velit

Locatii

APIs for managing locations

Display locations' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/locations/dropdown-values" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations/dropdown-values"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/locations/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of locations.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/locations?filter[id]=consectetur&filter[owner_id]=id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records_number\": 4
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations"
);

const params = {
    "filter[id]": "consectetur",
    "filter[owner_id]": "id",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "records_number": 4
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[id]   string  optional  

Field to filter by location. Example: consectetur

filter[owner_id]   string  optional  

Field to filter by owner. Example: id

Body Parameters

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 4

Store a newly created location.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/locations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 10,
    \"name\": \"tmmkvhvz\",
    \"surface\": 18,
    \"address\": \"tqtonowhpnazmdzenvextcmuc\",
    \"guests_number\": 18
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations"
);

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

let body = {
    "owner_id": 10,
    "name": "tmmkvhvz",
    "surface": 18,
    "address": "tqtonowhpnazmdzenvextcmuc",
    "guests_number": 18
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

owner_id   integer   

Example: 10

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: tmmkvhvz

surface   number   

Must be at least 0.01. Must not be greater than 999999.99. Example: 18

address   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: tqtonowhpnazmdzenvextcmuc

guests_number   integer  optional  

Must be at least 1. Must not be greater than 127. Example: 18

Show the specified location.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/locations/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/locations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the location. Example: 12

Update the specified location.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/locations/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 2,
    \"name\": \"dqiwwydkgvoxwjbhngy\",
    \"surface\": 20,
    \"address\": \"adtsculu\",
    \"guests_number\": 25
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations/3"
);

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

let body = {
    "owner_id": 2,
    "name": "dqiwwydkgvoxwjbhngy",
    "surface": 20,
    "address": "adtsculu",
    "guests_number": 25
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/locations/{id}

PATCH api/v1/locations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the location. Example: 3

Body Parameters

owner_id   integer   

Example: 2

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: dqiwwydkgvoxwjbhngy

surface   number   

Must be at least 0.01. Must not be greater than 999999.99. Example: 20

address   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: adtsculu

guests_number   integer  optional  

Must be at least 1. Must not be greater than 127. Example: 25

Delete the specified location.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/locations/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/locations/4"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/locations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the location. Example: 4

Notificari

APIs for managing notifications

Get user notifications.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/user-notifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user-notifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/user-notifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Profil brand

APIs for managing brand profile

Show brand profile.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/brand-profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-profile"
);

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

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

Example response (200):

{
    "data": {
        "name": "Profil",
        "address": "591 Windler Vista\nLangworthmouth, VA 03958",
        "city": "Lake Mylesmouth",
        "phone_fax": "863-484-8660",
        "mobile1": "775.987.5069",
        "mobile2": "+1-662-844-1314",
        "email1": "gkovacek@example.org",
        "email2": "shanelle59@example.net",
        "website": null,
        "facebook": null,
        "linkedin": null,
        "logo": null,
        "cover": null,
        "description": null,
        "currency": null
    }
}
 

Request      

GET api/v1/brand-profile

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update brand profile.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/brand-profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nume profil\",
    \"city\": \"Bucuresti\",
    \"address\": \"str. Comuna nr. 3, ap. 1\",
    \"phone_fax\": \"0123456789\",
    \"mobile1\": \"0123456789\",
    \"mobile2\": \"0123456789\",
    \"email1\": \"email1@example.com\",
    \"email2\": \"email2@example.com\",
    \"website\": \"https:\\/\\/yoursite.com\",
    \"facebook\": \"https:\\/\\/www.facebook.com\\/xxxxx | https:\\/\\/fb.com\\/xxxx\",
    \"linkedin\": \"https:\\/\\/www.linkedin.com\\/in\\/xxxxxxx\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-profile"
);

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

let body = {
    "name": "nume profil",
    "city": "Bucuresti",
    "address": "str. Comuna nr. 3, ap. 1",
    "phone_fax": "0123456789",
    "mobile1": "0123456789",
    "mobile2": "0123456789",
    "email1": "email1@example.com",
    "email2": "email2@example.com",
    "website": "https:\/\/yoursite.com",
    "facebook": "https:\/\/www.facebook.com\/xxxxx | https:\/\/fb.com\/xxxx",
    "linkedin": "https:\/\/www.linkedin.com\/in\/xxxxxxx"
};

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

Example response (200):

{
    "data": {
        "name": "Profil",
        "address": "5028 Cummings Shoal\nJacobistad, RI 30806-3311",
        "city": "East Olenton",
        "phone_fax": "+1 (903) 582-7509",
        "mobile1": "(681) 936-4096",
        "mobile2": "+1 (571) 378-9407",
        "email1": "jessy48@example.com",
        "email2": "easton.walker@example.com",
        "website": null,
        "facebook": null,
        "linkedin": null,
        "logo": null,
        "cover": null,
        "description": null,
        "currency": null
    }
}
 

Request      

PUT api/v1/brand-profile

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Must be at least 3 characters. Example: nume profil

city   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: Bucuresti

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: str. Comuna nr. 3, ap. 1

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 0123456789

mobile1   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 0123456789

mobile2   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 0123456789

email1   string  optional  

Must be a valid email address. Example: email1@example.com

email2   string  optional  

Must be a valid email address. Example: email2@example.com

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: https://yoursite.com

facebook   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([a-zA-z-.])?((facebook.com)|(fb.com))\/([\w .-])*\/?$/. Must not be greater than 255 characters. Example: https://www.facebook.com/xxxxx | https://fb.com/xxxx

linkedin   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([a-zA-z-.])?(linkedin.com)\/(in\/)([\w .-])*\/?$/. Must not be greater than 255 characters. Example: https://www.linkedin.com/in/xxxxxxx

Update brand profile's logo and/or cover.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/brand-profile-logo-and-cover" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "logo=@C:\Users\Stefi\AppData\Local\Temp\phpD85E.tmp" \
    --form "cover=@C:\Users\Stefi\AppData\Local\Temp\phpD85F.tmp" 
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-profile-logo-and-cover"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
body.append('cover', document.querySelector('input[name="cover"]').files[0]);

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

Example response (200):

{
    "data": {
        "name": "Profil",
        "address": "7288 Corkery Branch\nLawrencemouth, NH 99557-9640",
        "city": "North Charley",
        "phone_fax": "+1.828.644.6025",
        "mobile1": "1-914-207-5546",
        "mobile2": "(864) 826-0952",
        "email1": "deron.howe@example.org",
        "email2": "robbie.feest@example.org",
        "website": null,
        "facebook": null,
        "linkedin": null,
        "logo": null,
        "cover": null,
        "description": null,
        "currency": null
    }
}
 

Request      

POST api/v1/brand-profile-logo-and-cover

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

logo   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpD85E.tmp

cover   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpD85F.tmp

Update brand profile's additional details.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/brand-profile-additional-details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Hic fuga dicta itaque omnis enim et doloribus.\",
    \"currency\": \"EUR\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-profile-additional-details"
);

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

let body = {
    "description": "Hic fuga dicta itaque omnis enim et doloribus.",
    "currency": "EUR"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/brand-profile-additional-details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

description   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: Hic fuga dicta itaque omnis enim et doloribus.

currency   string  optional  

Must be one of EUR. Example: EUR

requires authentication

Delete brand profile's cover.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/brand-profile-cover" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-profile-cover"
);

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

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

Example response (200):

{
    "data": {
        "name": "Profil",
        "address": "5725 Kohler Springs Suite 260\nJanethaven, DE 16512",
        "city": "Petrashire",
        "phone_fax": "815.858.8081",
        "mobile1": "(279) 329-7216",
        "mobile2": "(872) 909-0451",
        "email1": "tessie.mcdermott@example.com",
        "email2": "kuhn.cheyenne@example.org",
        "website": null,
        "facebook": null,
        "linkedin": null,
        "logo": null,
        "cover": null,
        "description": null,
        "currency": null
    }
}
 

Request      

DELETE api/v1/brand-profile-cover

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Profiluri facturare brand

APIs for managing brand invoice profiles

Display a listing of invoice profiles.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/brand-invoice-profiles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles"
);

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

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

Example response (200):

{
    "data": [
        {
            "id": 1,
            "is_default_profile": true,
            "name": "Invoice profile name",
            "fiscal_code": "Invoice profile cui",
            "chamber_of_commerce_code": "Invoice profile nr reg comertului",
            "address": "Invoice profile address",
            "city": "Invoice profile city",
            "phone_fax": "Invoice profile phone fax",
            "mobile1": "Invoice profile mobile1",
            "mobile2": "Invoice profile mobile2",
            "email1": "Invoice profile email1",
            "email2": "Invoice profile email2",
            "website": "Invoice profile website",
            "invoice_no": 1,
            "bank": "Invoice profile bank",
            "bank_account": "Invoice profile bank account",
            "logo": null,
            "cover": null
        },
        {
            "id": 2,
            "is_default_profile": false,
            "name": "Invoice profile name",
            "fiscal_code": "Invoice profile cui",
            "chamber_of_commerce_code": "Invoice profile nr reg comertului",
            "address": "Invoice profile address",
            "city": "Invoice profile city",
            "phone_fax": "Invoice profile phone fax",
            "mobile1": "Invoice profile mobile1",
            "mobile2": "Invoice profile mobile2",
            "email1": "Invoice profile email1",
            "email2": "Invoice profile email2",
            "website": "Invoice profile website",
            "invoice_no": 1,
            "bank": "Invoice profile bank",
            "bank_account": "Invoice profile bank account",
            "logo": null,
            "cover": null
        }
    ]
}
 

Request      

GET api/v1/brand-invoice-profiles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created invoice profile.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nume\",
    \"city\": \"oras\",
    \"address\": \"adresa\",
    \"phone_fax\": \"telefon\",
    \"mobile1\": \"mobil 1\",
    \"mobile2\": \"mobil 2\",
    \"email1\": \"email 1\",
    \"email2\": \"email 2\",
    \"website\": \"website\",
    \"fiscal_code\": \"cod identificare fiscala\",
    \"chamber_of_commerce_code\": \"numar registrul comertului\",
    \"bank\": \"banca\",
    \"bank_account\": \"cont bancar\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles"
);

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

let body = {
    "name": "nume",
    "city": "oras",
    "address": "adresa",
    "phone_fax": "telefon",
    "mobile1": "mobil 1",
    "mobile2": "mobil 2",
    "email1": "email 1",
    "email2": "email 2",
    "website": "website",
    "fiscal_code": "cod identificare fiscala",
    "chamber_of_commerce_code": "numar registrul comertului",
    "bank": "banca",
    "bank_account": "cont bancar"
};

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

Example response (200):

{
    "data": {
        "id": 3,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

POST api/v1/brand-invoice-profiles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must be at least 3 characters. Example: nume

city   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: oras

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: adresa

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: telefon

mobile1   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 1

mobile2   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 2

email1   string  optional  

Must be a valid email address. Example: email 1

email2   string  optional  

Must be a valid email address. Example: email 2

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: website

fiscal_code   string   

Must match the regex /^[A-Za-z]{0,4}(?=.{2,13}$)[-\s0-9]*(?:[a-zA-Z][-\s0-9]*){0,2}$/. Example: cod identificare fiscala

chamber_of_commerce_code   string  optional  

Must be at least 4 characters. Must not be greater than 255 characters. Example: numar registrul comertului

bank   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: banca

bank_account   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: cont bancar

Display a invoice profile.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/7"
);

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

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

Example response (200):

{
    "data": {
        "id": 4,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

GET api/v1/brand-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the brand invoice profile. Example: 7

brand_invoice_profile   integer   

Example: 15

Update a invoice profile.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nume\",
    \"city\": \"oras\",
    \"address\": \"adresa\",
    \"phone_fax\": \"telefon\",
    \"mobile1\": \"mobil 1\",
    \"mobile2\": \"mobil 2\",
    \"email1\": \"email 1\",
    \"email2\": \"email 2\",
    \"website\": \"website\",
    \"fiscal_code\": \"cod identificare fiscala\",
    \"chamber_of_commerce_code\": \"numar registrul comertului\",
    \"bank\": \"banca\",
    \"bank_account\": \"cont bancar\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/20"
);

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

let body = {
    "name": "nume",
    "city": "oras",
    "address": "adresa",
    "phone_fax": "telefon",
    "mobile1": "mobil 1",
    "mobile2": "mobil 2",
    "email1": "email 1",
    "email2": "email 2",
    "website": "website",
    "fiscal_code": "cod identificare fiscala",
    "chamber_of_commerce_code": "numar registrul comertului",
    "bank": "banca",
    "bank_account": "cont bancar"
};

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

Example response (200):

{
    "data": {
        "id": 5,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

PUT api/v1/brand-invoice-profiles/{id}

PATCH api/v1/brand-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the brand invoice profile. Example: 20

brand_invoice_profile   integer   

Example: 7

Body Parameters

name   string   

Must be at least 3 characters. Example: nume

city   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: oras

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: adresa

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: telefon

mobile1   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 1

mobile2   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 2

email1   string  optional  

Must be a valid email address. Example: email 1

email2   string  optional  

Must be a valid email address. Example: email 2

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: website

fiscal_code   string   

Must match the regex /^[A-Za-z]{0,4}(?=.{2,13}$)[-\s0-9]*(?:[a-zA-Z][-\s0-9]*){0,2}$/. Example: cod identificare fiscala

chamber_of_commerce_code   string  optional  

Must be at least 4 characters. Must not be greater than 255 characters. Example: numar registrul comertului

bank   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: banca

bank_account   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: cont bancar

Remove a invoice profile.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profiles/19"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/brand-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the brand invoice profile. Example: 19

brand_invoice_profile   integer   

Example: 9

Delete brand invoice profile's logo.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-logo/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-logo/9"
);

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

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

Example response (200):

{
    "data": {
        "id": 6,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

DELETE api/v1/brand-invoice-profile-logo/{brand_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand_invoice_profile   integer   

Example: 9

Delete brand invoice profile's cover.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-cover/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-cover/15"
);

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

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

Example response (200):

{
    "data": {
        "id": 7,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

DELETE api/v1/brand-invoice-profile-cover/{brand_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand_invoice_profile   integer   

Example: 15

Update a brand invoice logo and/or cover.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-logo-and-cover/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "logo=@C:\Users\Stefi\AppData\Local\Temp\phpEB0E.tmp" \
    --form "cover=@C:\Users\Stefi\AppData\Local\Temp\phpEB0F.tmp" 
const url = new URL(
    "http://127.0.0.1:8000/api/v1/brand-invoice-profile-logo-and-cover/14"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
body.append('cover', document.querySelector('input[name="cover"]').files[0]);

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

Example response (200):

{
    "data": {
        "id": 8,
        "is_default_profile": false,
        "name": "Invoice profile name",
        "fiscal_code": "Invoice profile cui",
        "chamber_of_commerce_code": "Invoice profile nr reg comertului",
        "address": "Invoice profile address",
        "city": "Invoice profile city",
        "phone_fax": "Invoice profile phone fax",
        "mobile1": "Invoice profile mobile1",
        "mobile2": "Invoice profile mobile2",
        "email1": "Invoice profile email1",
        "email2": "Invoice profile email2",
        "website": "Invoice profile website",
        "invoice_no": 1,
        "bank": "Invoice profile bank",
        "bank_account": "Invoice profile bank account",
        "logo": null,
        "cover": null
    }
}
 

Request      

POST api/v1/brand-invoice-profile-logo-and-cover/{brand_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

brand_invoice_profile   integer   

Example: 14

Body Parameters

logo   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpEB0E.tmp

cover   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpEB0F.tmp

Set as default invoice profile for brand.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/default-brand-invoice-profile/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/default-brand-invoice-profile/19"
);

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

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

Example response (200):

{
    "data": {
        "name": "Profil",
        "address": "36029 Lazaro Dale\nThompsonton, AZ 56147-9365",
        "city": "West Alan",
        "phone_fax": "864.675.9006",
        "mobile1": "863.612.9091",
        "mobile2": "+1-551-584-3633",
        "email1": "delpha.dickens@example.com",
        "email2": "emmanuel.orn@example.com",
        "website": null,
        "facebook": null,
        "linkedin": null,
        "logo": null,
        "cover": null,
        "description": null,
        "currency": null
    }
}
 

Request      

PUT api/v1/default-brand-invoice-profile/{brand_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand_invoice_profile   integer   

Example: 19

Profiluri facturare proprietar

Display a listing of invoice profiles.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owner-invoice-profiles?filter[owner_id]=eos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles"
);

const params = {
    "filter[owner_id]": "eos",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

{
    "data": [
        {
            "id": null,
            "owner_id": null,
            "name": null,
            "fiscal_code": null,
            "chamber_of_commerce_code": null,
            "address": null,
            "city": null,
            "phone_fax": null,
            "mobile1": null,
            "mobile2": null,
            "email1": null,
            "email2": null,
            "website": null,
            "bank": null,
            "bank_account": null,
            "logo": null,
            "cover": null
        },
        {
            "id": null,
            "owner_id": null,
            "name": null,
            "fiscal_code": null,
            "chamber_of_commerce_code": null,
            "address": null,
            "city": null,
            "phone_fax": null,
            "mobile1": null,
            "mobile2": null,
            "email1": null,
            "email2": null,
            "website": null,
            "bank": null,
            "bank_account": null,
            "logo": null,
            "cover": null
        }
    ]
}
 

Request      

GET api/v1/owner-invoice-profiles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: eos

Store an owner invoice profile.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles?filter[owner_id]=dolor" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 8,
    \"name\": \"nume\",
    \"city\": \"oras\",
    \"address\": \"adresa\",
    \"phone_fax\": \"telefon\",
    \"mobile1\": \"mobil 1\",
    \"mobile2\": \"mobil 2\",
    \"email1\": \"email 1\",
    \"email2\": \"email 2\",
    \"website\": \"website\",
    \"fiscal_code\": \"cod identificare fiscala\",
    \"chamber_of_commerce_code\": \"numar registrul comertului\",
    \"bank\": \"banca\",
    \"bank_account\": \"cont bancar\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles"
);

const params = {
    "filter[owner_id]": "dolor",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "owner_id": 8,
    "name": "nume",
    "city": "oras",
    "address": "adresa",
    "phone_fax": "telefon",
    "mobile1": "mobil 1",
    "mobile2": "mobil 2",
    "email1": "email 1",
    "email2": "email 2",
    "website": "website",
    "fiscal_code": "cod identificare fiscala",
    "chamber_of_commerce_code": "numar registrul comertului",
    "bank": "banca",
    "bank_account": "cont bancar"
};

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

POST api/v1/owner-invoice-profiles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: dolor

Body Parameters

owner_id   integer   

Example: 8

name   string   

Must be at least 3 characters. Example: nume

city   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: oras

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: adresa

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: telefon

mobile1   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 1

mobile2   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 2

email1   string  optional  

Must be a valid email address. Example: email 1

email2   string  optional  

Must be a valid email address. Example: email 2

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: website

fiscal_code   string   

Must match the regex /^[A-Za-z]{0,4}(?=.{2,13}$)[-\s0-9]*(?:[a-zA-Z][-\s0-9]*){0,2}$/. Example: cod identificare fiscala

chamber_of_commerce_code   string  optional  

Must be at least 4 characters. Must not be greater than 255 characters. Example: numar registrul comertului

bank   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: banca

bank_account   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: cont bancar

Display a invoice profile.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/16?filter[owner_id]=cum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/16"
);

const params = {
    "filter[owner_id]": "cum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

GET api/v1/owner-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner invoice profile. Example: 16

owner_invoice_profile   integer   

Example: 1

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: cum

Update a invoice profile.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/19?filter[owner_id]=vel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 14,
    \"name\": \"nume\",
    \"city\": \"oras\",
    \"address\": \"adresa\",
    \"phone_fax\": \"telefon\",
    \"mobile1\": \"mobil 1\",
    \"mobile2\": \"mobil 2\",
    \"email1\": \"email 1\",
    \"email2\": \"email 2\",
    \"website\": \"website\",
    \"fiscal_code\": \"cod identificare fiscala\",
    \"chamber_of_commerce_code\": \"numar registrul comertului\",
    \"bank\": \"banca\",
    \"bank_account\": \"cont bancar\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/19"
);

const params = {
    "filter[owner_id]": "vel",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "owner_id": 14,
    "name": "nume",
    "city": "oras",
    "address": "adresa",
    "phone_fax": "telefon",
    "mobile1": "mobil 1",
    "mobile2": "mobil 2",
    "email1": "email 1",
    "email2": "email 2",
    "website": "website",
    "fiscal_code": "cod identificare fiscala",
    "chamber_of_commerce_code": "numar registrul comertului",
    "bank": "banca",
    "bank_account": "cont bancar"
};

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

PUT api/v1/owner-invoice-profiles/{id}

PATCH api/v1/owner-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner invoice profile. Example: 19

owner_invoice_profile   integer   

Example: 8

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: vel

Body Parameters

owner_id   integer   

Example: 14

name   string   

Must be at least 3 characters. Example: nume

city   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: oras

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: adresa

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: telefon

mobile1   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 1

mobile2   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: mobil 2

email1   string  optional  

Must be a valid email address. Example: email 1

email2   string  optional  

Must be a valid email address. Example: email 2

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: website

fiscal_code   string   

Must match the regex /^[A-Za-z]{0,4}(?=.{2,13}$)[-\s0-9]*(?:[a-zA-Z][-\s0-9]*){0,2}$/. Example: cod identificare fiscala

chamber_of_commerce_code   string  optional  

Must be at least 4 characters. Must not be greater than 255 characters. Example: numar registrul comertului

bank   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: banca

bank_account   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: cont bancar

Remove a invoice profile.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/9?filter[owner_id]=earum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profiles/9"
);

const params = {
    "filter[owner_id]": "earum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/owner-invoice-profiles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner invoice profile. Example: 9

owner_invoice_profile   integer   

Example: 6

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: earum

Delete owner invoice profile's logo.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-logo/11?filter[owner_id]=exercitationem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-logo/11"
);

const params = {
    "filter[owner_id]": "exercitationem",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

DELETE api/v1/owner-invoice-profile-logo/{owner_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

owner_invoice_profile   integer   

Example: 11

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: exercitationem

Delete owner invoice profile's cover.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-cover/18?filter[owner_id]=accusantium" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-cover/18"
);

const params = {
    "filter[owner_id]": "accusantium",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

DELETE api/v1/owner-invoice-profile-cover/{owner_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

owner_invoice_profile   integer   

Example: 18

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: accusantium

Update a owner invoice logo and/or cover.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-logo-and-cover/5?filter[owner_id]=consectetur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "logo=@C:\Users\Stefi\AppData\Local\Temp\phpEE4C.tmp" \
    --form "cover=@C:\Users\Stefi\AppData\Local\Temp\phpEE4D.tmp" 
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-invoice-profile-logo-and-cover/5"
);

const params = {
    "filter[owner_id]": "consectetur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
body.append('cover', document.querySelector('input[name="cover"]').files[0]);

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

Example response (200):

{
    "data": {
        "id": null,
        "owner_id": null,
        "name": null,
        "fiscal_code": null,
        "chamber_of_commerce_code": null,
        "address": null,
        "city": null,
        "phone_fax": null,
        "mobile1": null,
        "mobile2": null,
        "email1": null,
        "email2": null,
        "website": null,
        "bank": null,
        "bank_account": null,
        "logo": null,
        "cover": null
    }
}
 

Request      

POST api/v1/owner-invoice-profile-logo-and-cover/{owner_invoice_profile}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

owner_invoice_profile   integer   

Example: 5

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: consectetur

Body Parameters

logo   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpEE4C.tmp

cover   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpEE4D.tmp

Set as default invoice profile for owner.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/default-owner-invoice-profile/18?filter[owner_id]=est" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_invoice_profile_id\": 4
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/default-owner-invoice-profile/18"
);

const params = {
    "filter[owner_id]": "est",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "owner_invoice_profile_id": 4
};

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

Example response (200):

{
    "data": {
        "id": null,
        "user_id": null,
        "name": null,
        "address": null,
        "number": null
    }
}
 

Request      

PUT api/v1/default-owner-invoice-profile/{owner_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

owner_id   integer   

The ID of the owner. Example: 18

Query Parameters

filter[owner_id]   string  optional  

Field to filter by owner. APIs for managing owner invoice profiles Example: est

Body Parameters

owner_invoice_profile_id   integer   

Example: 4

Proprietari

APIs for managing owners

Display owners' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owners/dropdown-values" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners/dropdown-values"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/owners/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of owners.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owners?filter[id]=voluptatum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records_number\": 15
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners"
);

const params = {
    "filter[id]": "voluptatum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "records_number": 15
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/owners

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[id]   string  optional  

Field to filter by owner. Example: voluptatum

Body Parameters

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 15

Store a newly created owner.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/owners" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"olqwjktrgfdtcjsyllnsw\",
    \"address\": \"msedeivybsbqokrmfz\",
    \"number\": \"ddtyqbztobexohhjgelsbm\",
    \"user\": {
        \"username\": \"wuoqceuqvtahrhbdsljd\",
        \"password\": \"vC%j&^S()eK\",
        \"email\": \"roberta.koepp@example.com\",
        \"first_name\": \"ssxcentjxfdmhymddphkzyjbcnuvmzk\",
        \"last_name\": \"vgntnasaxnpfdejiefaaphsbmnmzvvbwmiwxesucjozrwcloqvphtomnxzvklzuifuslqxrpxcvxoxgtrlzdwvpann\",
        \"mobile\": \"+1779.-.990706\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners"
);

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

let body = {
    "name": "olqwjktrgfdtcjsyllnsw",
    "address": "msedeivybsbqokrmfz",
    "number": "ddtyqbztobexohhjgelsbm",
    "user": {
        "username": "wuoqceuqvtahrhbdsljd",
        "password": "vC%j&^S()eK",
        "email": "roberta.koepp@example.com",
        "first_name": "ssxcentjxfdmhymddphkzyjbcnuvmzk",
        "last_name": "vgntnasaxnpfdejiefaaphsbmnmzvvbwmiwxesucjozrwcloqvphtomnxzvklzuifuslqxrpxcvxoxgtrlzdwvpann",
        "mobile": "+1779.-.990706"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/owners

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: olqwjktrgfdtcjsyllnsw

address   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: msedeivybsbqokrmfz

number   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: ddtyqbztobexohhjgelsbm

user   object   
username   string   

Must contain only letters and numbers. Must be at least 3 characters. Example: wuoqceuqvtahrhbdsljd

password   string   

Must be at least 5 characters. Example: vC%j&^S()eK

email   string   

Must be a valid email address. Example: roberta.koepp@example.com

first_name   string   

Must be at least 3 characters. Example: ssxcentjxfdmhymddphkzyjbcnuvmzk

last_name   string   

Must be at least 3 characters. Example: vgntnasaxnpfdejiefaaphsbmnmzvvbwmiwxesucjozrwcloqvphtomnxzvklzuifuslqxrpxcvxoxgtrlzdwvpann

mobile   string   

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: +1779.-.990706

Show the specified owner.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owners/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/owners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner. Example: 13

Update the specified owner.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/owners/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dmtydzmhkpdbsxcsltnvwnjau\",
    \"address\": \"sbvvqqalflhlus\",
    \"number\": \"arlysanxosyq\",
    \"user\": {
        \"username\": \"jzemzbzmknn\",
        \"password\": \"$yjWHV\",
        \"email\": \"dakota25@example.net\",
        \"first_name\": \"pseeennitixijvpdagffzqhnajivkpymtftptkzujjezwnxvzbbyawforfxpbtxlvotkpavchd\",
        \"last_name\": \"ill\",
        \"mobile\": \"8039.0123ss91-74188s5\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners/15"
);

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

let body = {
    "name": "dmtydzmhkpdbsxcsltnvwnjau",
    "address": "sbvvqqalflhlus",
    "number": "arlysanxosyq",
    "user": {
        "username": "jzemzbzmknn",
        "password": "$yjWHV",
        "email": "dakota25@example.net",
        "first_name": "pseeennitixijvpdagffzqhnajivkpymtftptkzujjezwnxvzbbyawforfxpbtxlvotkpavchd",
        "last_name": "ill",
        "mobile": "8039.0123ss91-74188s5"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/owners/{id}

PATCH api/v1/owners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner. Example: 15

Body Parameters

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: dmtydzmhkpdbsxcsltnvwnjau

address   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: sbvvqqalflhlus

number   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: arlysanxosyq

user   object   
username   string   

Must contain only letters and numbers. Must be at least 3 characters. Example: jzemzbzmknn

password   string  optional  

Must be at least 5 characters. Example: $yjWHV

email   string  optional  

Must be a valid email address. Example: dakota25@example.net

first_name   string   

Must be at least 3 characters. Example: pseeennitixijvpdagffzqhnajivkpymtftptkzujjezwnxvzbbyawforfxpbtxlvotkpavchd

last_name   string   

Must be at least 3 characters. Example: ill

mobile   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 8039.0123ss91-74188s5

Delete the specified owner.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/owners/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owners/20"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/owners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner. Example: 20

Rapoarte

APIs for managing reports

Get owner sessions.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/owner-sessions?filter[id]=porro&filter[date_start]=totam&filter[date_end]=velit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/owner-sessions"
);

const params = {
    "filter[id]": "porro",
    "filter[date_start]": "totam",
    "filter[date_end]": "velit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "date_start": "2024-02-23",
        "date_end": "2024-02-23"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/owner-sessions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[id]   string  optional  

Field to filter by owner. Example: porro

filter[date_start]   string  optional  

Field to filter by session date start. Example: totam

filter[date_end]   string  optional  

Field to filter by session date end. Example: velit

Body Parameters

filter   object  optional  
date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

Get owner sessions' PDF.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/owner-sessions/12/generate-pdf?filter[id]=dolore&filter[date_start]=sunt&filter[date_end]=animi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/owner-sessions/12/generate-pdf"
);

const params = {
    "filter[id]": "dolore",
    "filter[date_start]": "sunt",
    "filter[date_end]": "animi",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "date_start": "2024-02-23",
        "date_end": "2024-02-23"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/owner-sessions/{owner_id}/generate-pdf

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

owner_id   integer   

The ID of the owner. Example: 12

Query Parameters

filter[id]   string  optional  

Field to filter by owner. Example: dolore

filter[date_start]   string  optional  

Field to filter by session date start. Example: sunt

filter[date_end]   string  optional  

Field to filter by session date end. Example: animi

Body Parameters

filter   object  optional  
date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

Get assigned sessions.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/assigned-sessions?filter[date_start]=velit&filter[date_end]=fugit&filter[status]=dolores" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\",
        \"status\": \"not_finished\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/assigned-sessions"
);

const params = {
    "filter[date_start]": "velit",
    "filter[date_end]": "fugit",
    "filter[status]": "dolores",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "date_start": "2024-02-23",
        "date_end": "2024-02-23",
        "status": "not_finished"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/assigned-sessions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[date_start]   string  optional  

Field to filter by date start. Example: velit

filter[date_end]   string  optional  

Field to filter by date end. Example: fugit

filter[status]   string  optional  

Field to filter by status (finished, unfinished, all). Example: dolores

Body Parameters

filter   object  optional  
date_start   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

status   string  optional  

Must be one of finished or not_finished. Example: not_finished

Get user's sessions.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/user-sessions?filter[session_status]=debitis&filter[session_date_start]=repudiandae&filter[session_date_end]=praesentium&filter[id]=expedita&timezone=Asia%2FKathmandu" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"session_date_start\": \"2024-02-23\",
        \"session_date_end\": \"2024-02-23\",
        \"session_status\": \"not_finished\",
        \"id\": 9
    },
    \"timezone\": \"Africa\\/Lagos\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/user-sessions"
);

const params = {
    "filter[session_status]": "debitis",
    "filter[session_date_start]": "repudiandae",
    "filter[session_date_end]": "praesentium",
    "filter[id]": "expedita",
    "timezone": "Asia/Kathmandu",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "session_date_start": "2024-02-23",
        "session_date_end": "2024-02-23",
        "session_status": "not_finished",
        "id": 9
    },
    "timezone": "Africa\/Lagos"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/user-sessions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[session_status]   string  optional  

Field to filter by session status (finished, unfinished, all). Example: debitis

filter[session_date_start]   string  optional  

Field to filter by session date start. Example: repudiandae

filter[session_date_end]   string  optional  

Field to filter by session date end. Example: praesentium

filter[id]   string  optional  

Field to filter by user. Example: expedita

timezone   string  optional  

Field to set the timezone. Example: Asia/Kathmandu

Body Parameters

filter   object  optional  
session_date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_status   string  optional  

Must be one of finished or not_finished. Example: not_finished

id   integer  optional  

Example: 9

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: Africa/Lagos

Get user sessions' PDF.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/user-sessions/1/generate-pdf?filter[session_status]=officia&filter[session_date_start]=veniam&filter[session_date_end]=qui&filter[id]=nisi&timezone=Antarctica%2FRothera" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"session_date_start\": \"2024-02-23\",
        \"session_date_end\": \"2024-02-23\",
        \"session_status\": \"finished\",
        \"id\": 19
    },
    \"timezone\": \"America\\/Marigot\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/user-sessions/1/generate-pdf"
);

const params = {
    "filter[session_status]": "officia",
    "filter[session_date_start]": "veniam",
    "filter[session_date_end]": "qui",
    "filter[id]": "nisi",
    "timezone": "Antarctica/Rothera",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "session_date_start": "2024-02-23",
        "session_date_end": "2024-02-23",
        "session_status": "finished",
        "id": 19
    },
    "timezone": "America\/Marigot"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/user-sessions/{user_id}/generate-pdf

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Query Parameters

filter[session_status]   string  optional  

Field to filter by session status (finished, unfinished, all). Example: officia

filter[session_date_start]   string  optional  

Field to filter by session date start. Example: veniam

filter[session_date_end]   string  optional  

Field to filter by session date end. Example: qui

filter[id]   string  optional  

Field to filter by user. Example: nisi

timezone   string  optional  

Field to set the timezone. Example: Antarctica/Rothera

Body Parameters

filter   object  optional  
session_date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_status   string  optional  

Must be one of finished or not_finished. Example: finished

id   integer  optional  

Example: 19

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: America/Marigot

Get user's timers.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/user-timers?filter[session_status]=magnam&filter[session_date_start]=iure&filter[session_date_end]=qui&filter[id]=enim&timezone=America%2FGrand_Turk" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"session_date_start\": \"2024-02-23\",
        \"session_date_end\": \"2024-02-23\",
        \"session_status\": \"not_finished\",
        \"id\": 2
    },
    \"timezone\": \"Africa\\/Conakry\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/user-timers"
);

const params = {
    "filter[session_status]": "magnam",
    "filter[session_date_start]": "iure",
    "filter[session_date_end]": "qui",
    "filter[id]": "enim",
    "timezone": "America/Grand_Turk",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "session_date_start": "2024-02-23",
        "session_date_end": "2024-02-23",
        "session_status": "not_finished",
        "id": 2
    },
    "timezone": "Africa\/Conakry"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/user-timers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[session_status]   string  optional  

Field to filter by session status (finished, unfinished, all). Example: magnam

filter[session_date_start]   string  optional  

Field to filter by session date start. Example: iure

filter[session_date_end]   string  optional  

Field to filter by session date end. Example: qui

filter[id]   string  optional  

Field to filter by user. Example: enim

timezone   string  optional  

Field to set the timezone. Example: America/Grand_Turk

Body Parameters

filter   object  optional  
session_date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_status   string  optional  

Must be one of finished or not_finished. Example: not_finished

id   integer  optional  

Example: 2

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: Africa/Conakry

Get user's timers PDF.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reports/user-timers/1/generate-pdf?filter[session_status]=quis&filter[session_date_start]=similique&filter[session_date_end]=saepe&filter[id]=aut&timezone=America%2FBoise" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"session_date_start\": \"2024-02-23\",
        \"session_date_end\": \"2024-02-23\",
        \"session_status\": \"finished\",
        \"id\": 8
    },
    \"timezone\": \"Asia\\/Thimphu\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reports/user-timers/1/generate-pdf"
);

const params = {
    "filter[session_status]": "quis",
    "filter[session_date_start]": "similique",
    "filter[session_date_end]": "saepe",
    "filter[id]": "aut",
    "timezone": "America/Boise",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "session_date_start": "2024-02-23",
        "session_date_end": "2024-02-23",
        "session_status": "finished",
        "id": 8
    },
    "timezone": "Asia\/Thimphu"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reports/user-timers/{user_id}/generate-pdf

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Query Parameters

filter[session_status]   string  optional  

Field to filter by session status (finished, unfinished, all). Example: quis

filter[session_date_start]   string  optional  

Field to filter by session date start. Example: similique

filter[session_date_end]   string  optional  

Field to filter by session date end. Example: saepe

filter[id]   string  optional  

Field to filter by user. Example: aut

timezone   string  optional  

Field to set the timezone. Example: America/Boise

Body Parameters

filter   object  optional  
session_date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

session_status   string  optional  

Must be one of finished or not_finished. Example: finished

id   integer  optional  

Example: 8

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: Asia/Thimphu

Rezervari

APIs for managing reservations

Display reservations' graphical representation.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reservations-graphical-representation?filter[id]=optio&filter[location_id]=ipsum&start_date=quia&number_of_days=alias&filter[assigned_sessions]=doloribus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2024-02-23\",
    \"number_of_days\": 7,
    \"filter\": {
        \"location_id\": 20,
        \"assigned_sessions\": \"false\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations-graphical-representation"
);

const params = {
    "filter[id]": "optio",
    "filter[location_id]": "ipsum",
    "start_date": "quia",
    "number_of_days": "alias",
    "filter[assigned_sessions]": "doloribus",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "start_date": "2024-02-23",
    "number_of_days": 7,
    "filter": {
        "location_id": 20,
        "assigned_sessions": "false"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reservations-graphical-representation

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[id]   string  optional  

Field to filter by owner. Example: optio

filter[location_id]   string  optional  

Field to filter by location. Example: ipsum

start_date   string  optional  

Field to filter by start date. Example: quia

number_of_days   string  optional  

Field to filter by date interval. Example: alias

filter[assigned_sessions]   string  optional  

Field to filter by assigned sessions. Example: doloribus

Body Parameters

start_date   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

number_of_days   integer   

Must be at least 0. Must not be greater than 31. Example: 7

filter   object  optional  
location_id   integer  optional  

Example: 20

assigned_sessions   string  optional  

Must be one of true or false. Example: false

Acknowledge a reservation.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/reservations/7/acknowledge" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations/7/acknowledge"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/reservations/{reservation_id}/acknowledge

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reservation_id   integer   

The ID of the reservation. Example: 7

Display reservations' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reservations/dropdown-values?filter[started_at]=laudantium&filter[ended_at]=non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"started_at\": \"2024-02-23\",
        \"ended_at\": \"2024-02-23\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations/dropdown-values"
);

const params = {
    "filter[started_at]": "laudantium",
    "filter[ended_at]": "non",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "started_at": "2024-02-23",
        "ended_at": "2024-02-23"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reservations/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[started_at]   string  optional  

Field to filter by start date. Example: laudantium

filter[ended_at]   string  optional  

Field to filter by end date. Example: non

Body Parameters

filter   object  optional  
started_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

ended_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

Display a listing of reservations.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reservations?filter[started_at]=odit&filter[ended_at]=ullam&filter[location_id]=et&filter[acknowledged]=voluptatum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records_number\": 2,
    \"filter\": {
        \"started_at\": \"2024-02-23\",
        \"ended_at\": \"2024-02-23\",
        \"acknowledged\": \"true\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations"
);

const params = {
    "filter[started_at]": "odit",
    "filter[ended_at]": "ullam",
    "filter[location_id]": "et",
    "filter[acknowledged]": "voluptatum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "records_number": 2,
    "filter": {
        "started_at": "2024-02-23",
        "ended_at": "2024-02-23",
        "acknowledged": "true"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reservations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[started_at]   string  optional  

Field to filter by start date. Example: odit

filter[ended_at]   string  optional  

Field to filter by end date. Example: ullam

filter[location_id]   string  optional  

Field to filter by location. Example: et

filter[location.owner_id]   string  optional  

Field to filter by owner. Example: inventore

filter[acknowledged]   string  optional  

Field to filter by acknowledge status (true, false). Example: voluptatum

Body Parameters

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 2

filter   object  optional  
started_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

ended_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

acknowledged   string  optional  

Must be one of true or false. Example: true

Store a newly created reservation.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/reservations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 3,
    \"started_at\": \"2024-02-23 08:50:15\",
    \"ended_at\": \"2044-11-03\",
    \"visitor_name\": \"akzk\",
    \"visitor_phone\": \"2s780384sss35.ss40\",
    \"add_maintenance_session\": false,
    \"guests_number\": 24,
    \"sheets_number\": 25,
    \"children_number\": 23,
    \"pets_number\": 1,
    \"observations\": \"et\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations"
);

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

let body = {
    "location_id": 3,
    "started_at": "2024-02-23 08:50:15",
    "ended_at": "2044-11-03",
    "visitor_name": "akzk",
    "visitor_phone": "2s780384sss35.ss40",
    "add_maintenance_session": false,
    "guests_number": 24,
    "sheets_number": 25,
    "children_number": 23,
    "pets_number": 1,
    "observations": "et"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/reservations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

location_id   integer   

Example: 3

started_at   string   

Must be a valid date in the format Y-m-d H:i:s. Example: 2024-02-23 08:50:15

ended_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date after started_at. Example: 2044-11-03

visitor_name   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: akzk

visitor_phone   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 2s780384sss35.ss40

add_maintenance_session   boolean  optional  

Example: false

guests_number   integer  optional  

Must be at least 1. Must not be greater than 127. Example: 24

sheets_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 25

children_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 23

pets_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 1

observations   string  optional  

Example: et

Show the specified reservation.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/reservations/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the reservation. Example: 20

Update the specified reservation.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/reservations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 20,
    \"started_at\": \"2024-02-23 08:50:15\",
    \"ended_at\": \"2036-01-14\",
    \"visitor_name\": \"ewxmjpttvs\",
    \"visitor_phone\": \"+.213834-6.\",
    \"guests_number\": 25,
    \"sheets_number\": 22,
    \"children_number\": 13,
    \"pets_number\": 14,
    \"observations\": \"quae\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations/1"
);

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

let body = {
    "location_id": 20,
    "started_at": "2024-02-23 08:50:15",
    "ended_at": "2036-01-14",
    "visitor_name": "ewxmjpttvs",
    "visitor_phone": "+.213834-6.",
    "guests_number": 25,
    "sheets_number": 22,
    "children_number": 13,
    "pets_number": 14,
    "observations": "quae"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/reservations/{id}

PATCH api/v1/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the reservation. Example: 1

Body Parameters

location_id   integer   

Example: 20

started_at   string   

Must be a valid date in the format Y-m-d H:i:s. Example: 2024-02-23 08:50:15

ended_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date after started_at. Example: 2036-01-14

visitor_name   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: ewxmjpttvs

visitor_phone   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: +.213834-6.

guests_number   integer  optional  

Must be at least 1. Must not be greater than 127. Example: 25

sheets_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 22

children_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 13

pets_number   integer  optional  

Must be at least 0. Must not be greater than 127. Example: 14

observations   string  optional  

Example: quae

Delete the specified reservation.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/reservations/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reservations/20"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the reservation. Example: 20

Roluri

APIs for managing roles

Display roles' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/roles/dropdown-values" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles/dropdown-values"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/roles/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Roles listing.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles"
);

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

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

Example response (200):

{
    "data": [
        {
            "id": 5,
            "name": "role title",
            "permissions_names": [],
            "permissions": []
        },
        {
            "id": null,
            "name": "role title",
            "permissions_names": [],
            "permissions": []
        }
    ]
}
 

Request      

GET api/v1/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created role.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"hijisacpsqnfbxusxpdhktjruiawowoxyvcnngsgb\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles"
);

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

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

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

Example response (200):

{
    "data": {
        "id": 7,
        "name": "role title",
        "permissions_names": [],
        "permissions": []
    }
}
 

Request      

POST api/v1/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must be at least 3 characters. Example: hijisacpsqnfbxusxpdhktjruiawowoxyvcnngsgb

Display a role.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles/1"
);

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

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

Example response (200):

{
    "data": {
        "id": 8,
        "name": "role title",
        "permissions_names": [],
        "permissions": []
    }
}
 

Request      

GET api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

role   integer   

Example: 19

Update a role.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ybhsfylqfhvoqxpvd\",
    \"permissions\": [
        \"repudiandae\"
    ]
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles/1"
);

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

let body = {
    "name": "ybhsfylqfhvoqxpvd",
    "permissions": [
        "repudiandae"
    ]
};

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

Example response (200):

{
    "data": {
        "id": 9,
        "name": "role title",
        "permissions_names": [],
        "permissions": []
    }
}
 

Request      

PUT api/v1/roles/{id}

PATCH api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

Body Parameters

name   string   

Must be at least 3 characters. Example: ybhsfylqfhvoqxpvd

permissions   string[]   

Remove a role.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/roles/1"
);

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

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

Example response (200):

1
 

Request      

DELETE api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

Permissions names listing.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/permissions-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/permissions-list"
);

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

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

Example response (200):

{
    "data": [
        "permissions1",
        "permissions2"
    ]
}
 

Request      

GET api/v1/permissions-list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Permissions detailed listing.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/permissions-detailed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/permissions-detailed"
);

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

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

Example response (200):

{
    "data": [
        {
            "name": "Permission name",
            "shortName": "lang_permissions.Permission short description",
            "category": "lang_permissions.Permission category",
            "subcategory": "lang_permissions.Permission subcategory",
            "short_description": "lang_permissions.Permission short description",
            "description": "lang_permissions.Permission description",
            "guard": "api"
        },
        {
            "name": "Permission name",
            "shortName": "lang_permissions.Permission short description",
            "category": "lang_permissions.Permission category",
            "subcategory": "lang_permissions.Permission subcategory",
            "short_description": "lang_permissions.Permission short description",
            "description": "lang_permissions.Permission description",
            "guard": "api"
        }
    ]
}
 

Request      

GET api/v1/permissions-detailed

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Permission detailed.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/permission/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/permission/1"
);

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

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

Example response (200):

{
    "data": {
        "name": "Permission name",
        "shortName": "lang_permissions.Permission short description",
        "category": "lang_permissions.Permission category",
        "subcategory": "lang_permissions.Permission subcategory",
        "short_description": "lang_permissions.Permission short description",
        "description": "lang_permissions.Permission description",
        "guard": "api"
    }
}
 

Request      

GET api/v1/permission/{permission_name}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permission_name   integer   

Example: 1

Rute tehnice

Run migrations

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/migrate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/migrate"
);

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

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

Example response (200):

{
    "message": "migrating complete"
}
 

Request      

GET api/technical/migrate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Drop tables & rerun migrations

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/migrate_fresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/migrate_fresh"
);

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

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

Example response (200):

{
    "message": "migrating fresh complete"
}
 

Request      

GET api/technical/migrate_fresh

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Rollback migrations 1 step

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/migrate_rollback" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/migrate_rollback"
);

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

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

Example response (200):

{
    "message": "migrate back 1 step complete"
}
 

Request      

GET api/technical/migrate_rollback

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Seed database

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/seed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/seed"
);

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

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

Example response (200):

{
    "message": "seed complete"
}
 

Request      

GET api/technical/seed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Clear cache

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/clear_cache" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/clear_cache"
);

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

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

Example response (200):

{
    "message": "clear cache complete"
}
 

Request      

GET api/technical/clear_cache

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Reset database

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/reset_database" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/reset_database"
);

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

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

Example response (200):

{
    "message": "Database refreshed"
}
 

Request      

GET api/technical/reset_database

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Update permissions

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/technical/update_permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/technical/update_permissions"
);

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

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

Example response (200):

{
    "message": "update permissions complete"
}
 

Request      

GET api/technical/update_permissions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Servicii

APIs for managing services

Display a listing of services.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/services" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/services"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/services

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created service.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/services" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"utkyvazvbkdc\",
    \"price\": 18,
    \"measurement_unit\": \"hrs\",
    \"vat\": 17
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/services"
);

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

let body = {
    "name": "utkyvazvbkdc",
    "price": 18,
    "measurement_unit": "hrs",
    "vat": 17
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/services

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: utkyvazvbkdc

price   number   

Must be at least 0.01. Must not be greater than 999999.99. Example: 18

measurement_unit   string   

Must be one of pcs, hrs, kg, or package. Example: hrs

vat   integer   

Must not be greater than 100. Example: 17

Show the specified service.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/services/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/services/4"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the service. Example: 4

Update the specified service.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/services/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"yrxvjvxjzionhutyemrrogqv\",
    \"price\": 6,
    \"measurement_unit\": \"kg\",
    \"vat\": 7
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/services/18"
);

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

let body = {
    "name": "yrxvjvxjzionhutyemrrogqv",
    "price": 6,
    "measurement_unit": "kg",
    "vat": 7
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/services/{id}

PATCH api/v1/services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the service. Example: 18

Body Parameters

name   string   

Must be at least 1 character. Must not be greater than 255 characters. Example: yrxvjvxjzionhutyemrrogqv

price   number   

Must be at least 0.01. Must not be greater than 999999.99. Example: 6

measurement_unit   string   

Must be one of pcs, hrs, kg, or package. Example: kg

vat   integer   

Must not be greater than 100. Example: 7

Delete the specified service.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/services/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/services/11"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the service. Example: 11

Servicii locatie

APIs for managing location services

Display a listing of location services.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/location-services/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/location-services/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/location-services/{location_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

location_id   integer   

The ID of the location. Example: 7

Store a newly created location service.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/location-services" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 8,
    \"service_id\": 8,
    \"price\": 13
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/location-services"
);

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

let body = {
    "location_id": 8,
    "service_id": 8,
    "price": 13
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/location-services

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

location_id   integer   

Example: 8

service_id   integer   

Example: 8

price   number   

Must be at least 0.01. Must not be greater than 999999.99. Example: 13

Show the specified location service.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/location-services/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/location-services/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/location-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the location service. Example: 1

Delete the specified location service.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/location-services/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/location-services/18"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/location-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the location service. Example: 18

Servicii proprietar

APIs for managing owner services

Display a listing of owner services.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owner-services/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-services/6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/owner-services/{owner_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

owner_id   integer   

The ID of the owner. Example: 6

Store a newly created owner service.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/owner-services" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 2,
    \"service_id\": 1,
    \"price\": 6
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-services"
);

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

let body = {
    "owner_id": 2,
    "service_id": 1,
    "price": 6
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/owner-services

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

owner_id   integer   

Example: 2

service_id   integer   

Example: 1

price   number  optional  

Must be at least 0.01. Must not be greater than 999999.99. Example: 6

Show the specified owner service.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/owner-services/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-services/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/owner-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner service. Example: 17

Delete the specified owner service.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/owner-services/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/owner-services/17"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/owner-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the owner service. Example: 17

Servicii sesiune

APIs for managing session services

Display a listing of session services.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/session-services/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-services/5"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/session-services/{session_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 5

Store a newly created session service.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/session-services" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": 10,
    \"service_id\": 7,
    \"amount\": 47
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-services"
);

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

let body = {
    "session_id": 10,
    "service_id": 7,
    "amount": 47
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/session-services

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

session_id   integer   

Example: 10

service_id   integer   

Example: 7

amount   number   

Must be at least 0. Example: 47

Show the specified session service.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/session-services/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-services/19"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/session-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session service. Example: 19

Delete the specified session service.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/session-services/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-services/16"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/session-services/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session service. Example: 16

Display provided session services.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/provided-session-services/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/provided-session-services/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/provided-session-services/{session_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 9

Sesiuni

APIs for managing sessions

Display sessions' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/sessions/dropdown-values?filter[location_id]=dolorem&filter[owner_id]=veritatis&filter[date_start]=fugiat&filter[date_end]=est&filter[date]=debitis&filter[status]=maxime&filter[assigned]=aspernatur&filter[acknowledged]=consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"date\": \"2024-02-23\",
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\",
        \"owner_id\": 16,
        \"status\": \"not_finished\",
        \"assigned\": \"true\",
        \"acknowledged\": \"false\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/dropdown-values"
);

const params = {
    "filter[location_id]": "dolorem",
    "filter[owner_id]": "veritatis",
    "filter[date_start]": "fugiat",
    "filter[date_end]": "est",
    "filter[date]": "debitis",
    "filter[status]": "maxime",
    "filter[assigned]": "aspernatur",
    "filter[acknowledged]": "consequatur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "date": "2024-02-23",
        "date_start": "2024-02-23",
        "date_end": "2024-02-23",
        "owner_id": 16,
        "status": "not_finished",
        "assigned": "true",
        "acknowledged": "false"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/sessions/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[location_id]   string  optional  

Field to filter by location. Example: dolorem

filter[owner_id]   string  optional  

Field to filter by owner. Example: veritatis

filter[date_start]   string  optional  

Field to filter by date start. Example: fugiat

filter[date_end]   string  optional  

Field to filter by date end. Example: est

filter[date]   string  optional  

Field to filter by date. Example: debitis

filter[status]   string  optional  

Field to filter by status (finished, unfinished, all). Example: maxime

filter[assigned]   string  optional  

Field to filter by assigned status (true, false). Example: aspernatur

filter[acknowledged]   string  optional  

Field to filter by acknowledge status (true, false). Example: consequatur

Body Parameters

filter   object  optional  
date   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_start   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

owner_id   integer  optional  

Example: 16

status   string  optional  

Must be one of finished or not_finished. Example: not_finished

assigned   string  optional  

Must be one of true or false. Example: true

acknowledged   string  optional  

Must be one of true or false. Example: false

Mark session as not finished.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/sessions/2/mark-as-not-finished" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/2/mark-as-not-finished"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/sessions/{session_id}/mark-as-not-finished

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 2

Mark session as finished.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/sessions/19/mark-as-finished" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/19/mark-as-finished"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/sessions/{session_id}/mark-as-finished

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 19

Acknowledge a session.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/sessions/9/acknowledge" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/9/acknowledge"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/sessions/{session_id}/acknowledge

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 9

Display a listing of sessions.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/sessions?filter[employee_id]=debitis&filter[location_id]=soluta&filter[date_start]=aut&filter[date_end]=harum&filter[status]=tempore&filter[assigned]=ut&filter[acknowledged]=impedit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records_number\": 13,
    \"filter\": {
        \"date_start\": \"2024-02-23\",
        \"date_end\": \"2024-02-23\",
        \"status\": \"finished\",
        \"assigned\": \"true\",
        \"acknowledged\": \"false\",
        \"employee_id\": 6
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions"
);

const params = {
    "filter[employee_id]": "debitis",
    "filter[location_id]": "soluta",
    "filter[date_start]": "aut",
    "filter[date_end]": "harum",
    "filter[status]": "tempore",
    "filter[assigned]": "ut",
    "filter[acknowledged]": "impedit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "records_number": 13,
    "filter": {
        "date_start": "2024-02-23",
        "date_end": "2024-02-23",
        "status": "finished",
        "assigned": "true",
        "acknowledged": "false",
        "employee_id": 6
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/sessions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[employee_id]   string  optional  

Field to filter by employee. Example: debitis

filter[location_id]   string  optional  

Field to filter by location. Example: soluta

filter[location.owner_id]   string  optional  

Field to filter by owner. Example: incidunt

filter[date_start]   string  optional  

Field to filter by date start. Example: aut

filter[date_end]   string  optional  

Field to filter by date end. Example: harum

filter[status]   string  optional  

Field to filter by status (finished, unfinished, all). Example: tempore

filter[assigned]   string  optional  

Field to filter by assigned status (true, false). Example: ut

filter[acknowledged]   string  optional  

Field to filter by acknowledge status (true, false). Example: impedit

Body Parameters

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

filter   object  optional  
date_start   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

date_end   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

status   string  optional  

Must be one of finished or not_finished. Example: finished

assigned   string  optional  

Must be one of true or false. Example: true

acknowledged   string  optional  

Must be one of true or false. Example: false

employee_id   integer  optional  

Example: 6

Store a newly created session.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/sessions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 19,
    \"assigned_to_user_id\": 13,
    \"reservation_id\": 8,
    \"owner_id\": 6,
    \"date\": \"2024-02-23\",
    \"observations\": \"ut\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions"
);

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

let body = {
    "location_id": 19,
    "assigned_to_user_id": 13,
    "reservation_id": 8,
    "owner_id": 6,
    "date": "2024-02-23",
    "observations": "ut"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/sessions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

location_id   integer  optional  

This field is required when reservation_id is present. Example: 19

assigned_to_user_id   integer  optional  

Example: 13

reservation_id   integer  optional  

Example: 8

owner_id   integer   

Example: 6

date   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

observations   string  optional  

Example: ut

Show the specified session.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/sessions/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/sessions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session. Example: 17

Update the specified session.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/sessions/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location_id\": 7,
    \"assigned_to_user_id\": 18,
    \"reservation_id\": 2,
    \"owner_id\": 3,
    \"date\": \"2024-02-23\",
    \"observations\": \"aut\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/8"
);

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

let body = {
    "location_id": 7,
    "assigned_to_user_id": 18,
    "reservation_id": 2,
    "owner_id": 3,
    "date": "2024-02-23",
    "observations": "aut"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/sessions/{id}

PATCH api/v1/sessions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session. Example: 8

Body Parameters

location_id   integer  optional  

This field is required when reservation_id is present. Example: 7

assigned_to_user_id   integer  optional  

Example: 18

reservation_id   integer  optional  

Example: 2

owner_id   integer   

Example: 3

date   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

observations   string  optional  

Example: aut

Delete the specified session.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/sessions/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/11"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/sessions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session. Example: 11

Setari

APIs for getting configurations

User statuses configuration

requires authentication

Possible values of user status

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/user-statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user-statuses"
);

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

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

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 240
x-ratelimit-remaining: 234
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "data": [
        {
            "value": "active",
            "title": "activ"
        },
        {
            "value": "inactive",
            "title": "inactiv"
        }
    ]
}
 

Request      

GET api/v1/user-statuses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of settings.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the specified setting.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/settings/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/settings/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/settings/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the setting. Example: 1

Update the specified setting.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/settings/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"value\": \"ya\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/settings/1"
);

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

let body = {
    "value": "ya"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/settings/{id}

PATCH api/v1/settings/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the setting. Example: 1

Body Parameters

value   string  optional  

Must be at least 1 character. Must not be greater than 255 characters. Example: ya

Get enum's values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/enum-values/enim" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/enum-values/enim"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/enum-values/{key}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

key   string   

Example: enim

Get enums keys.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/enums-keys" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/enums-keys"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/enums-keys

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Timpi sesiune

APIs for managing session timers

Start a new session timer.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/start-session-timer" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": 13
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/start-session-timer"
);

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

let body = {
    "session_id": 13
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/start-session-timer

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

session_id   integer   

Example: 13

End the specified session timer.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/session-timers/17/end" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers/17/end"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/session-timers/{session_timer}/end

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_timer   integer   

Example: 17

Display a listing of session timers.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/session-timers?filter[user_id]=dolor&filter[started_at_start]=voluptatem&filter[started_at_end]=sit&filter[finished_at_start]=laborum&filter[finished_at_end]=blanditiis&filter[assigned_sessions]=voluptas&filter[is_active]=labore&filter[owner_id]=quia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"user_id\": 12,
        \"started_at_start\": \"2024-02-23\",
        \"started_at_end\": \"2024-02-23\",
        \"finished_at_start\": \"2024-02-23\",
        \"finished_at_end\": \"2024-02-23\",
        \"owner_id\": 6,
        \"is_active\": \"false\",
        \"assigned_sessions\": \"false\"
    },
    \"records_number\": 9
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers"
);

const params = {
    "filter[user_id]": "dolor",
    "filter[started_at_start]": "voluptatem",
    "filter[started_at_end]": "sit",
    "filter[finished_at_start]": "laborum",
    "filter[finished_at_end]": "blanditiis",
    "filter[assigned_sessions]": "voluptas",
    "filter[is_active]": "labore",
    "filter[owner_id]": "quia",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "filter": {
        "user_id": 12,
        "started_at_start": "2024-02-23",
        "started_at_end": "2024-02-23",
        "finished_at_start": "2024-02-23",
        "finished_at_end": "2024-02-23",
        "owner_id": 6,
        "is_active": "false",
        "assigned_sessions": "false"
    },
    "records_number": 9
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/session-timers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[user_id]   string  optional  

Field to filter by user. Example: dolor

filter[started_at_start]   string  optional  

Field to filter by started at start. Example: voluptatem

filter[started_at_end]   string  optional  

Field to filter by started at end. Example: sit

filter[finished_at_start]   string  optional  

Field to filter by finished at start. Example: laborum

filter[finished_at_end]   string  optional  

Field to filter by finished at end. Example: blanditiis

filter[assigned_sessions]   string  optional  

Field to filter by assigned sessions. Example: voluptas

filter[is_active]   string  optional  

Field to filter by status. Example: labore

filter[owner_id]   string  optional  

Field to filter by owner. Example: quia

Body Parameters

filter   object  optional  
user_id   integer  optional  

Example: 12

started_at_start   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

started_at_end   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

finished_at_start   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

finished_at_end   string  optional  

Must be a valid date in the format Y-m-d. Example: 2024-02-23

owner_id   integer  optional  

Example: 6

is_active   string  optional  

Must be one of true or false. Example: false

assigned_sessions   string  optional  

Must be one of true or false. Example: false

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 9

Store a newly created session timer.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/session-timers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": 8,
    \"user_id\": 19,
    \"started_at\": \"2002-09-30\",
    \"finished_at\": \"1994-11-12\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers"
);

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

let body = {
    "session_id": 8,
    "user_id": 19,
    "started_at": "2002-09-30",
    "finished_at": "1994-11-12"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/session-timers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

session_id   integer   

Example: 8

user_id   integer   

Example: 19

started_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date before or equal to now. Example: 2002-09-30

finished_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date after started_at. Must be a date before or equal to now. Example: 1994-11-12

Show the specified session timer.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/session-timers/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/session-timers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session timer. Example: 3

Update the specified session timer.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/session-timers/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": 4,
    \"user_id\": 3,
    \"started_at\": \"2021-11-15\",
    \"finished_at\": \"1995-11-29\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers/9"
);

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

let body = {
    "session_id": 4,
    "user_id": 3,
    "started_at": "2021-11-15",
    "finished_at": "1995-11-29"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

PUT api/v1/session-timers/{id}

PATCH api/v1/session-timers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session timer. Example: 9

Body Parameters

session_id   integer   

Example: 4

user_id   integer   

Example: 3

started_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date before or equal to now. Example: 2021-11-15

finished_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date after started_at. Must be a date before or equal to now. Example: 1995-11-29

Delete the specified session timer.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/session-timers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-timers/1"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/session-timers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session timer. Example: 1

Utilizatori

APIs for managing users

Reset user password.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/reset-password?email=fritz27%40example.org&token=quo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"ibechtelar@example.org\",
    \"token\": \"consequatur\",
    \"password\": \"@N7($O}wPD&ogX+1\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/reset-password"
);

const params = {
    "email": "fritz27@example.org",
    "token": "quo",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "email": "ibechtelar@example.org",
    "token": "consequatur",
    "password": "@N7($O}wPD&ogX+1"
};

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

Example response (422):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 240
x-ratelimit-remaining: 239
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "The given data was invalid",
    "errors": {
        "password": [
            "The password confirmation does not match."
        ]
    }
}
 

Request      

POST api/v1/reset-password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

email   string   

email Example: fritz27@example.org

token   string   

Example: quo

Body Parameters

email   string   

Must be a valid email address. Must be at least 5 characters. Example: ibechtelar@example.org

token   string   

Example: consequatur

password   string   

Example: @N7($O}wPD&ogX+1

Login a user.

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"consequuntur\",
    \"password\": \"v_M?\\\"Xf\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/login"
);

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

let body = {
    "username": "consequuntur",
    "password": "v_M?\"Xf"
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 240
x-ratelimit-remaining: 236
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "The provided credentials are incorrect"
}
 

Request      

POST api/v1/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string  optional  

required. Example: consequuntur

password   string  optional  

required. Example: v_M?"Xf

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/email-reset-link" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"reichert.isidro@example.net\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/email-reset-link"
);

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

let body = {
    "email": "reichert.isidro@example.net"
};

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

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 240
x-ratelimit-remaining: 235
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Reset password link sent if email exists in database"
}
 

Logout logged user token.

requires authentication

Deletes token

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/logout"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/logout

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Refresh token.

requires authentication

Deletes current token for user and generate 1 new

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/refresh" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/refresh"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/refresh

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display users' dropdown values.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/users/dropdown-values" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users/dropdown-values"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/users/dropdown-values

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Application's users.

requires authentication

This endpoint allows you to see application's users.

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/users?filter[id]=voluptas" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records_number\": 14
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users"
);

const params = {
    "filter[id]": "voluptas",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "records_number": 14
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[id]   string  optional  

Field to filter by user. Example: voluptas

filter[roles.id]   string  optional  

Field to filter by role. Example: sapiente

Body Parameters

records_number   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 14

Store a newly created user.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data ""
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users"
);

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

let body = ;

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

Example response (200):

{
    "data": {
        "username": "tillman.schmeler",
        "first_name": "Claude",
        "last_name": "Mraz",
        "mobile": "1-760-593-4926",
        "phone_fax": "(856) 573-3946",
        "email": "joanny34@example.net",
        "website": "http://www.stroman.com/dolores-fugiat-ducimus-est-eaque.html",
        "address": "75311 Dicki Isle\nKarellebury, OH 59408-3492",
        "status": [
            "status3"
        ],
        "profile_pic": null,
        "use_profile_pic": true,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

POST api/v1/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string   

Must contain only letters and numbers. Must be at least 3 characters. Example: nmteiwordzhpzttorvydqhchfxjlzzsyubmmtafvghwgtfxdn

first_name   string   

Must be at least 3 characters. Example: akoukqmgrokmyppjecbcukggfizyv

last_name   string   

Must be at least 3 characters. Example: pfxzqnksbpplietupryqftcetqzdnamiqfxbibvpbhmosr

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 9.4--5598ss2.015ss26.17

mobile   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 80s68.s46776s-624099ss

email   string   

Must be a valid email address. Example: elwyn49@example.net

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: fplyzorvgosbodiqcr

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example:

status   string   

Example: rerum

use_profile_pic   boolean  optional  

Example: false

roles_ids   integer[]   
password   string   

Must be at least 5 characters. Example: n0[?$<[}sC,r~ILgAf

password_confirmation   required  optional  

Example: ea

Display a user.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users/1"
);

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

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

Example response (200):

{
    "data": {
        "username": "jaylan25",
        "first_name": "Larue",
        "last_name": "Konopelski",
        "mobile": "909.249.4650",
        "phone_fax": "+1 (520) 412-7092",
        "email": "kuphal.elda@example.com",
        "website": "http://ward.org/",
        "address": "40990 Aditya Parkways Apt. 102\nSouth Gussie, IL 62117-8188",
        "status": [
            "status3"
        ],
        "profile_pic": null,
        "use_profile_pic": false,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

GET api/v1/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

user   integer   

Example: 5

Update a user.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"spqaxwncorbsvyyssbubkwvkcsdcpiv\",
    \"first_name\": \"epfyrtwswjauwtidy\",
    \"last_name\": \"xmoihfcjqzjymkifsmxqyqbmjxpqhusikylyfwghyesmyirgfbbhtkhsxgkbiuadgnt\",
    \"phone_fax\": \"+73836.806.076844\",
    \"mobile\": \"0s-s49656003.1\",
    \"email\": \"tillman33@example.org\",
    \"website\": \"xfiptpzco\",
    \"address\": \"d \\/+$\\/um\",
    \"status\": \"doloribus\",
    \"use_profile_pic\": true,
    \"roles_ids\": [
        16
    ],
    \"password\": \"ZRH)]=,z>]Eh8\",
    \"password_confirmation\": \"ut\"
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users/1"
);

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

let body = {
    "username": "spqaxwncorbsvyyssbubkwvkcsdcpiv",
    "first_name": "epfyrtwswjauwtidy",
    "last_name": "xmoihfcjqzjymkifsmxqyqbmjxpqhusikylyfwghyesmyirgfbbhtkhsxgkbiuadgnt",
    "phone_fax": "+73836.806.076844",
    "mobile": "0s-s49656003.1",
    "email": "tillman33@example.org",
    "website": "xfiptpzco",
    "address": "d \/+$\/um",
    "status": "doloribus",
    "use_profile_pic": true,
    "roles_ids": [
        16
    ],
    "password": "ZRH)]=,z>]Eh8",
    "password_confirmation": "ut"
};

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

Example response (200):

{
    "data": {
        "username": "joanny46",
        "first_name": "Cole",
        "last_name": "Ratke",
        "mobile": "801.712.7058",
        "phone_fax": "+1 (985) 378-5851",
        "email": "moises.bahringer@example.com",
        "website": "http://west.info/in-et-nihil-quia-dolore-odio.html",
        "address": "28950 Volkman Springs\nArmandoview, KS 89441-2065",
        "status": [
            "status2"
        ],
        "profile_pic": null,
        "use_profile_pic": true,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

PUT api/v1/users/{id}

PATCH api/v1/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

user   integer   

Example: 2

Body Parameters

username   string   

Must contain only letters and numbers. Must be at least 3 characters. Example: spqaxwncorbsvyyssbubkwvkcsdcpiv

first_name   string   

Must be at least 3 characters. Example: epfyrtwswjauwtidy

last_name   string   

Must be at least 3 characters. Example: xmoihfcjqzjymkifsmxqyqbmjxpqhusikylyfwghyesmyirgfbbhtkhsxgkbiuadgnt

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: +73836.806.076844

mobile   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 0s-s49656003.1

email   string  optional  

Must be a valid email address. Example: tillman33@example.org

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: xfiptpzco

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example: d /+$/um

status   string   

Example: doloribus

use_profile_pic   boolean  optional  

Example: true

roles_ids   integer[]   
password   string  optional  

Must be at least 5 characters. Example: ZRH)]=,z>]Eh8

password_confirmation   required  optional  

Example: ut

Remove an user.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/users/1"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

Logged user profile.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user"
);

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

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

Example response (200):

{
    "data": {
        "username": "schuster.terrance",
        "first_name": "Dominique",
        "last_name": "Rutherford",
        "mobile": "+1-231-792-7622",
        "phone_fax": "678-759-4211",
        "email": "ondricka.haven@example.org",
        "website": "http://walter.com/",
        "address": "176 Alexzander Coves\nEast Jayden, CT 72924-6810",
        "status": [
            "status4"
        ],
        "profile_pic": null,
        "use_profile_pic": true,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

GET api/v1/user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update logged user profile.

requires authentication

Example request:
curl --request PUT \
    "http://127.0.0.1:8000/api/v1/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data ""
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user"
);

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

let body = ;

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

Example response (200):

{
    "data": {
        "username": "grant87",
        "first_name": "Markus",
        "last_name": "Strosin",
        "mobile": "986.543.0303",
        "phone_fax": "520.765.4024",
        "email": "qernser@example.org",
        "website": "https://franecki.biz/doloribus-eum-suscipit-ratione-iure-sit-qui.html",
        "address": "681 Gaylord Neck\nLake Nathanael, NJ 18759-5718",
        "status": [
            "status3"
        ],
        "profile_pic": null,
        "use_profile_pic": true,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

PUT api/v1/user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Must be at least 3 characters. Example: jvr

last_name   string   

Must be at least 3 characters. Example: sajoeudwevtioseefyghkapwnfsefnwyx

phone_fax   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: 0271s8.707.s086ss04-

mobile   string  optional  

Must match the regex /^+?[0-9.-\s]{10,25}$/. Example: ss08813-.567102.0028565

email   string  optional  

Must be a valid email address. Example: wiza.ezekiel@example.org

website   string  optional  

Must be a valid URL. Must match the regex /^(https?:\/\/)?([\da-z.-]+).([a-z.]{2,6})([\/\w .-])\/?$/. Must not be greater than 255 characters. Example: ytloxvlxvkifawwvor

address   string  optional  

Must match the regex /^[a-zรขฤƒรฎลŸศ™ลฃศ›A-Zฤ‚ร‚รŽลžศ˜ลขศš0-9 -\/\ +().,:\/]*$/um. Example:

status   string   

Example: occaecati

use_profile_pic   boolean  optional  

Example: false

password   string  optional  

Must be at least 5 characters. Example: g44iT8

password_confirmation   required  optional  

Example: voluptates

Update user's profile picture.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/user-profile-photo/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "picture=@C:\Users\Stefi\AppData\Local\Temp\phpD763.tmp" 
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user-profile-photo/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('picture', document.querySelector('input[name="picture"]').files[0]);

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

Example response (200):

{
    "data": {
        "username": "jpadberg",
        "first_name": "Ottilie",
        "last_name": "Feeney",
        "mobile": "(361) 283-3922",
        "phone_fax": "+14784636521",
        "email": "pwilliamson@example.org",
        "website": "http://www.murphy.com/neque-sint-repellat-est-quis-fugit-nostrum-vel.html",
        "address": "891 Reymundo Harbors\nSipesbury, MI 83511",
        "status": [
            "status3"
        ],
        "profile_pic": null,
        "use_profile_pic": false,
        "roles_ids": null,
        "roles": null,
        "permissions": null
    }
}
 

Request      

POST api/v1/user-profile-photo/{user_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

user   integer   

Example: 2

Body Parameters

picture   file  optional  

Example: C:\Users\Stefi\AppData\Local\Temp\phpD763.tmp

Utilizatori sesiune

APIs for managing session users

Display a listing of session users.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/sessions/14/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/sessions/14/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/sessions/{session_id}/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

session_id   integer   

The ID of the session. Example: 14

Show user's finished sessions count.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/user-sessions-count" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": {
        \"sessionKVMKQRx9GGgJgkb0date_start\": \"2024-02-23\",
        \"sessionKVMKQRx9GGgJgkb0date_end\": \"2024-02-23\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/user-sessions-count"
);

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

let body = {
    "filter": {
        "sessionKVMKQRx9GGgJgkb0date_start": "2024-02-23",
        "sessionKVMKQRx9GGgJgkb0date_end": "2024-02-23"
    }
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/user-sessions-count

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[session.date_start]   string  optional  

Field to filter by date start. Example: mollitia

filter[session.date_end]   string  optional  

Field to filter by date end. Example: aut

Body Parameters

filter   object  optional  
sessionKVMKQRx9GGgJgkb0date_start   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

sessionKVMKQRx9GGgJgkb0date_end   string   

Must be a valid date in the format Y-m-d. Example: 2024-02-23

Store a newly created session user.

requires authentication

Example request:
curl --request POST \
    "http://127.0.0.1:8000/api/v1/session-users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": 13,
    \"user_id\": 8
}"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-users"
);

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

let body = {
    "session_id": 13,
    "user_id": 8
};

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

POST api/v1/session-users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

session_id   integer   

Example: 13

user_id   integer   

Example: 8

Show the specified session user.

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/v1/session-users/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-users/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "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
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

GET api/v1/session-users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session user. Example: 18

Delete the specified session user.

requires authentication

Example request:
curl --request DELETE \
    "http://127.0.0.1:8000/api/v1/session-users/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/v1/session-users/9"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "message": "Unauthorized"
}
 

Request      

DELETE api/v1/session-users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session user. Example: 9

X_unsorted_endpoints

GET api/api-version

requires authentication

Example request:
curl --request GET \
    --get "http://127.0.0.1:8000/api/api-version" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8000/api/api-version"
);

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

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

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 240
x-ratelimit-remaining: 237
access-control-allow-origin: *
access-control-expose-headers: Content-Disposition
 
{
    "api_version": "1.1.0"
}
 

Request      

GET api/api-version

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json