MENU navbar-image

Introduction

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

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

Authenticating requests

This API is not authenticated.

Endpoints

POST api/login

Example request:
curl --request POST \
    "http://localhost/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"architecto\",
    \"password\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/login"
);

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

let body = {
    "username": "architecto",
    "password": "architecto"
};

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

Request      

POST api/login

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

username   string     

Example: architecto

password   string     

Example: architecto

GET api/patch_notes/public_display

Example request:
curl --request GET \
    --get "http://localhost/api/patch_notes/public_display" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/patch_notes/public_display"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "status": 200,
    "message": "Patch notes display successfully.",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 2,
                "title": "Test",
                "description": "Test 1",
                "version": "1.0.0",
                "filename": "test2.txt",
                "filepath": "storage/patch-notes/HK8BS3xKIrek4iUS0DTXu4TuHeiB9p4i6LLWdXuS.txt",
                "type": "feature",
                "is_published": true,
                "published_at": "2025-10-12T23:41:11.000000Z",
                "created_at": "2025-10-12T23:41:05.000000Z",
                "updated_at": "2025-10-12T23:41:11.000000Z",
                "deleted_at": null,
                "file_url": "http://localhost/storage/patch-notes/HK8BS3xKIrek4iUS0DTXu4TuHeiB9p4i6LLWdXuS.txt"
            },
            {
                "id": 1,
                "title": "Patch Note Version 1",
                "description": "Patch note for the month of august! please be advise",
                "version": "1.2",
                "filename": "Prototype1.pdf",
                "filepath": "storage/patch-notes/aaaOlT8ubr3NyIRlyNkcRoYwXfGgks0dbuMn0FXV.pdf",
                "type": "feature",
                "is_published": true,
                "published_at": "2025-10-09T21:59:17.000000Z",
                "created_at": "2025-10-09T21:59:15.000000Z",
                "updated_at": "2025-10-09T21:59:17.000000Z",
                "deleted_at": null,
                "file_url": "http://localhost/storage/patch-notes/aaaOlT8ubr3NyIRlyNkcRoYwXfGgks0dbuMn0FXV.pdf"
            }
        ],
        "first_page_url": "http://localhost/api/patch_notes/public_display?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost/api/patch_notes/public_display?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://localhost/api/patch_notes/public_display?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost/api/patch_notes/public_display",
        "per_page": 20,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}

Request      

GET api/patch_notes/public_display

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/patch_notes/{patchNote_id}/public_display

Example request:
curl --request GET \
    --get "http://localhost/api/patch_notes/1/public_display" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/patch_notes/1/public_display"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "status": 200,
    "message": "Patch note display successfully",
    "data": {
        "id": 1,
        "title": "Patch Note Version 1",
        "description": "Patch note for the month of august! please be advise",
        "version": "1.2",
        "filename": "Prototype1.pdf",
        "filepath": "storage/patch-notes/aaaOlT8ubr3NyIRlyNkcRoYwXfGgks0dbuMn0FXV.pdf",
        "type": "feature",
        "is_published": true,
        "published_at": "2025-10-09T21:59:17.000000Z",
        "created_at": "2025-10-09T21:59:15.000000Z",
        "updated_at": "2025-10-09T21:59:17.000000Z",
        "deleted_at": null,
        "file_url": "http://localhost/storage/patch-notes/aaaOlT8ubr3NyIRlyNkcRoYwXfGgks0dbuMn0FXV.pdf"
    }
}

Request      

GET api/patch_notes/{patchNote_id}/public_display

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

patchNote_id   integer     

The ID of the patchNote. Example: 1

GET api/one_charging/api

Example request:
curl --request GET \
    --get "http://localhost/api/one_charging/api" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/one_charging/api"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthorized",
            "detail": "Invalid API Key"
        }
    ]
}

Request      

GET api/one_charging/api

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/one_charging/sync

Example request:
curl --request POST \
    "http://localhost/api/one_charging/sync" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/one_charging/sync"
);

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

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

Request      

POST api/one_charging/sync

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/logout

Example request:
curl --request POST \
    "http://localhost/api/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/logout"
);

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

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

Request      

POST api/logout

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/one_charging

Example request:
curl --request GET \
    --get "http://localhost/api/one_charging" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"active\"
}"

const url = new URL(
    "http://localhost/api/one_charging"
);

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

let body = {
    "status": "active"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/one_charging

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: active

Must be one of:
  • active
  • inactive

GET api/one_charging/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/one_charging/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/one_charging/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/one_charging/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the one charging. Example: architecto

POST api/one_charging/system_sync

Example request:
curl --request POST \
    "http://localhost/api/one_charging/system_sync" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/one_charging/system_sync"
);

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

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

Request      

POST api/one_charging/system_sync

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

PATCH api/users/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/users/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/users/architecto/toggle_archived"
);

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

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

Request      

PATCH api/users/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the user. Example: architecto

PATCH api/users/{id}/reset_password

Example request:
curl --request PATCH \
    "http://localhost/api/users/architecto/reset_password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/users/architecto/reset_password"
);

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

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

Request      

PATCH api/users/{id}/reset_password

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the user. Example: architecto

GET api/sedar_employees

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

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/sedar_employees

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/users

Example request:
curl --request GET \
    --get "http://localhost/api/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"active\"
}"

const url = new URL(
    "http://localhost/api/users"
);

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

let body = {
    "status": "active"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: active

Must be one of:
  • active
  • inactive

POST api/users

Example request:
curl --request POST \
    "http://localhost/api/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"personal_info\": {
        \"mobile_number\": \"+635642559314\",
        \"gender\": \"male\",
        \"one_charging_id\": \"architecto\"
    },
    \"username\": \"architecto\",
    \"role_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/users"
);

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

let body = {
    "personal_info": {
        "mobile_number": "+635642559314",
        "gender": "male",
        "one_charging_id": "architecto"
    },
    "username": "architecto",
    "role_id": "architecto"
};

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

Request      

POST api/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

personal_info   object  optional    
id_prefix   string  optional    
id_no   string  optional    
first_name   string  optional    
last_name   string  optional    
mobile_number   string  optional    

Must match the regex /^+63\d{10}$/. Example: +635642559314

gender   string  optional    

Example: male

Must be one of:
  • male
  • female
one_charging_id   string     

The sync_id of an existing record in the one_charging table. Example: architecto

username   string     

Example: architecto

role_id   string     

The id of an existing record in the roles table. Example: architecto

GET api/users/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/users/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/users/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the user. Example: architecto

PUT api/users/{id}

Example request:
curl --request PUT \
    "http://localhost/api/users/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"personal_info\": {
        \"mobile_number\": \"+635642559314\",
        \"gender\": \"male\",
        \"one_charging_id\": \"architecto\"
    },
    \"username\": \"architecto\",
    \"role_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/users/architecto"
);

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

let body = {
    "personal_info": {
        "mobile_number": "+635642559314",
        "gender": "male",
        "one_charging_id": "architecto"
    },
    "username": "architecto",
    "role_id": "architecto"
};

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

Request      

PUT api/users/{id}

PATCH api/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the user. Example: architecto

Body Parameters

personal_info   object  optional    
id_prefix   string  optional    
id_no   string  optional    
first_name   string  optional    
last_name   string  optional    
mobile_number   string  optional    

Must match the regex /^+63\d{10}$/. Example: +635642559314

gender   string  optional    

Example: male

Must be one of:
  • male
  • female
one_charging_id   string     

The sync_id of an existing record in the one_charging table. Example: architecto

username   string     

Example: architecto

role_id   string     

The id of an existing record in the roles table. Example: architecto

PATCH api/role/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/role/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/role/architecto/toggle_archived"
);

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

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

Request      

PATCH api/role/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the role. Example: architecto

GET api/role

Example request:
curl --request GET \
    --get "http://localhost/api/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/role"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/role

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/role

Example request:
curl --request POST \
    "http://localhost/api/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"access_permission\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "http://localhost/api/role"
);

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

let body = {
    "name": "architecto",
    "access_permission": [
        "architecto"
    ]
};

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

Request      

POST api/role

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: architecto

access_permission   string[]     

GET api/role/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/role/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/role/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/role/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the role. Example: architecto

PUT api/role/{id}

Example request:
curl --request PUT \
    "http://localhost/api/role/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"access_permission\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "http://localhost/api/role/architecto"
);

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

let body = {
    "name": "architecto",
    "access_permission": [
        "architecto"
    ]
};

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

Request      

PUT api/role/{id}

PATCH api/role/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the role. Example: architecto

Body Parameters

name   string     

Example: architecto

access_permission   string[]     

PATCH api/region/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/region/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/region/architecto/toggle_archived"
);

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

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

Request      

PATCH api/region/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the region. Example: architecto

GET api/region

Example request:
curl --request GET \
    --get "http://localhost/api/region" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/region"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/region

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/region

Example request:
curl --request POST \
    "http://localhost/api/region" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"region_head_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/region"
);

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

let body = {
    "name": "architecto",
    "region_head_id": "architecto"
};

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

Request      

POST api/region

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: architecto

region_head_id   string     

The id of an existing record in the users table. Example: architecto

GET api/region/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/region/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/region/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/region/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the region. Example: architecto

PUT api/region/{id}

Example request:
curl --request PUT \
    "http://localhost/api/region/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"region_head_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/region/architecto"
);

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

let body = {
    "name": "architecto",
    "region_head_id": "architecto"
};

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

Request      

PUT api/region/{id}

PATCH api/region/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the region. Example: architecto

Body Parameters

name   string     

Example: architecto

region_head_id   string     

The id of an existing record in the users table. Example: architecto

PATCH api/area/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/area/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/area/architecto/toggle_archived"
);

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

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

Request      

PATCH api/area/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the area. Example: architecto

GET api/area

Example request:
curl --request GET \
    --get "http://localhost/api/area" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"active\"
}"

const url = new URL(
    "http://localhost/api/area"
);

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

let body = {
    "status": "active"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/area

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: active

Must be one of:
  • active
  • inactive

POST api/area

Example request:
curl --request POST \
    "http://localhost/api/area" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"region_id\": \"architecto\",
    \"area_head_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/area"
);

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

let body = {
    "name": "architecto",
    "region_id": "architecto",
    "area_head_id": "architecto"
};

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

Request      

POST api/area

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: architecto

region_id   string     

The id of an existing record in the regions table. Example: architecto

area_head_id   string     

The id of an existing record in the users table. Example: architecto

area_list   object  optional    

GET api/area/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/area/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/area/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/area/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the area. Example: architecto

PUT api/area/{id}

Example request:
curl --request PUT \
    "http://localhost/api/area/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"region_id\": \"architecto\",
    \"area_head_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/area/architecto"
);

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

let body = {
    "name": "architecto",
    "region_id": "architecto",
    "area_head_id": "architecto"
};

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

Request      

PUT api/area/{id}

PATCH api/area/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the area. Example: architecto

Body Parameters

name   string     

Example: architecto

region_id   string     

The id of an existing record in the regions table. Example: architecto

area_head_id   string     

The id of an existing record in the users table. Example: architecto

area_list   object  optional    

PATCH api/checklist/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/checklist/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/checklist/architecto/toggle_archived"
);

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

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

Request      

PATCH api/checklist/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the checklist. Example: architecto

GET api/checklist

Example request:
curl --request GET \
    --get "http://localhost/api/checklist" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"active\"
}"

const url = new URL(
    "http://localhost/api/checklist"
);

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

let body = {
    "status": "active"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/checklist

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: active

Must be one of:
  • active
  • inactive

POST api/checklist

Example request:
curl --request POST \
    "http://localhost/api/checklist" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"sections\": [
        {
            \"title\": \"architecto\",
            \"order_index\": 16,
            \"questions\": [
                {
                    \"question_text\": \"architecto\",
                    \"question_type\": \"multiple_choice\",
                    \"order_index\": 16,
                    \"options\": [
                        {
                            \"option_text\": \"architecto\",
                            \"order_index\": 16
                        }
                    ]
                }
            ]
        }
    ]
}"

const url = new URL(
    "http://localhost/api/checklist"
);

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

let body = {
    "name": "architecto",
    "sections": [
        {
            "title": "architecto",
            "order_index": 16,
            "questions": [
                {
                    "question_text": "architecto",
                    "question_type": "multiple_choice",
                    "order_index": 16,
                    "options": [
                        {
                            "option_text": "architecto",
                            "order_index": 16
                        }
                    ]
                }
            ]
        }
    ]
};

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

Request      

POST api/checklist

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: architecto

sections   object[]     
title   string     

Example: architecto

order_index   integer     

Example: 16

questions   object[]     
question_text   string     

Example: architecto

question_type   string     

Example: multiple_choice

Must be one of:
  • text
  • multiple_choice
  • checkboxes
  • paragraph
  • radio_button
order_index   integer     

Example: 16

options   object[]  optional    

This field is required when sections..questions..question_type is multiple_choice, checkboxes, or radio_button.
option_text   string  optional    

This field is required when sections..questions..options is present. Example: architecto

order_index   integer  optional    

This field is required when sections..questions..options is present. Example: 16

GET api/checklist/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/checklist/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/checklist/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/checklist/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the checklist. Example: architecto

PUT api/checklist/{id}

Example request:
curl --request PUT \
    "http://localhost/api/checklist/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"sections\": [
        {
            \"title\": \"architecto\",
            \"order_index\": 16,
            \"questions\": [
                {
                    \"question_text\": \"architecto\",
                    \"question_type\": \"multiple_choice\",
                    \"order_index\": 16,
                    \"options\": [
                        {
                            \"option_text\": \"architecto\",
                            \"order_index\": 16
                        }
                    ]
                }
            ]
        }
    ]
}"

const url = new URL(
    "http://localhost/api/checklist/architecto"
);

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

let body = {
    "name": "architecto",
    "sections": [
        {
            "title": "architecto",
            "order_index": 16,
            "questions": [
                {
                    "question_text": "architecto",
                    "question_type": "multiple_choice",
                    "order_index": 16,
                    "options": [
                        {
                            "option_text": "architecto",
                            "order_index": 16
                        }
                    ]
                }
            ]
        }
    ]
};

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

Request      

PUT api/checklist/{id}

PATCH api/checklist/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the checklist. Example: architecto

Body Parameters

name   string     

Example: architecto

sections   object[]     
title   string     

Example: architecto

order_index   integer     

Example: 16

questions   object[]     
question_text   string     

Example: architecto

question_type   string     

Example: multiple_choice

Must be one of:
  • text
  • multiple_choice
  • checkboxes
  • paragraph
  • radio_button
order_index   integer     

Example: 16

options   object[]  optional    

This field is required when sections..questions..question_type is multiple_choice, checkboxes, or radio_button.
option_text   string  optional    

This field is required when sections..questions..options is present. Example: architecto

order_index   integer  optional    

This field is required when sections..questions..options is present. Example: 16

PATCH api/store/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/store/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/store/architecto/toggle_archived"
);

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

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

Request      

PATCH api/store/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store. Example: architecto

GET api/store

Example request:
curl --request GET \
    --get "http://localhost/api/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/store"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/store

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/store

Example request:
curl --request POST \
    "http://localhost/api/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"area_id\": \"architecto\",
    \"region_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/store"
);

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

let body = {
    "name": "architecto",
    "area_id": "architecto",
    "region_id": "architecto"
};

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

Request      

POST api/store

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: architecto

area_id   string     

The id of an existing record in the areas table. Example: architecto

region_id   string     

The id of an existing record in the regions table. Example: architecto

GET api/store/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/store/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/store/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/store/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store. Example: architecto

PUT api/store/{id}

Example request:
curl --request PUT \
    "http://localhost/api/store/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"area_id\": \"architecto\",
    \"region_id\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/store/architecto"
);

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

let body = {
    "name": "architecto",
    "area_id": "architecto",
    "region_id": "architecto"
};

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

Request      

PUT api/store/{id}

PATCH api/store/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store. Example: architecto

Body Parameters

name   string     

Example: architecto

area_id   string     

The id of an existing record in the areas table. Example: architecto

region_id   string     

The id of an existing record in the regions table. Example: architecto

PATCH api/store_checklist/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/store_checklist/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/store_checklist/architecto/toggle_archived"
);

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

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

Request      

PATCH api/store_checklist/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store checklist. Example: architecto

GET api/store_checklist

Example request:
curl --request GET \
    --get "http://localhost/api/store_checklist" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/store_checklist"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/store_checklist

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/store_checklist

Example request:
curl --request POST \
    "http://localhost/api/store_checklist" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"store_id\": 16,
    \"store_name\": \"architecto\",
    \"checklist_id\": 16,
    \"checklist_name\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/store_checklist"
);

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

let body = {
    "store_id": 16,
    "store_name": "architecto",
    "checklist_id": 16,
    "checklist_name": "architecto"
};

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

Request      

POST api/store_checklist

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

store_id   integer     

The id of an existing record in the stores table. Example: 16

store_name   string     

Example: architecto

checklist_id   integer     

The id of an existing record in the checklists table. Example: 16

checklist_name   string     

Example: architecto

GET api/store_checklist/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/store_checklist/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/store_checklist/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/store_checklist/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store checklist. Example: architecto

PUT api/store_checklist/{id}

Example request:
curl --request PUT \
    "http://localhost/api/store_checklist/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"store_id\": 16,
    \"store_name\": \"architecto\",
    \"checklist_id\": 16,
    \"checklist_name\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/store_checklist/architecto"
);

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

let body = {
    "store_id": 16,
    "store_name": "architecto",
    "checklist_id": 16,
    "checklist_name": "architecto"
};

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

Request      

PUT api/store_checklist/{id}

PATCH api/store_checklist/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the store checklist. Example: architecto

Body Parameters

store_id   integer     

The id of an existing record in the stores table. Example: 16

store_name   string     

Example: architecto

checklist_id   integer     

The id of an existing record in the checklists table. Example: 16

checklist_name   string     

Example: architecto

GET api/patch_notes/download/{filename}

Example request:
curl --request GET \
    --get "http://localhost/api/patch_notes/download/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/patch_notes/download/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/patch_notes/download/{filename}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

filename   string     

Example: architecto

PATCH api/patch_notes/{id}/publish_update

Example request:
curl --request PATCH \
    "http://localhost/api/patch_notes/1/publish_update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/patch_notes/1/publish_update"
);

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

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

Request      

PATCH api/patch_notes/{id}/publish_update

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the patch note. Example: 1

GET api/patch_notes

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

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/patch_notes

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/patch_notes

Example request:
curl --request POST \
    "http://localhost/api/patch_notes" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=b"\
    --form "description=Eius et animi quos velit et."\
    --form "version=v"\
    --form "type=breaking"\
    --form "is_published="\
    --form "file=@C:\Users\bclerigo\AppData\Local\Temp\php8173.tmp" 
const url = new URL(
    "http://localhost/api/patch_notes"
);

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

const body = new FormData();
body.append('title', 'b');
body.append('description', 'Eius et animi quos velit et.');
body.append('version', 'v');
body.append('type', 'breaking');
body.append('is_published', '');
body.append('file', document.querySelector('input[name="file"]').files[0]);

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

Request      

POST api/patch_notes

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

title   string     

Must not be greater than 255 characters. Example: b

description   string     

Example: Eius et animi quos velit et.

version   string  optional    

Must not be greater than 50 characters. Example: v

type   string     

Example: breaking

Must be one of:
  • feature
  • bugfix
  • security
  • performance
  • breaking
file   file     

Must be a file. Must not be greater than 10240 kilobytes. Example: C:\Users\bclerigo\AppData\Local\Temp\php8173.tmp

is_published   boolean  optional    

Example: false

GET api/patch_notes/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/patch_notes/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/patch_notes/1"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/patch_notes/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the patch note. Example: 1

PUT api/patch_notes/{id}

Example request:
curl --request PUT \
    "http://localhost/api/patch_notes/1" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=b"\
    --form "description=Eius et animi quos velit et."\
    --form "version=v"\
    --form "type=feature"\
    --form "is_published="\
    --form "file=@C:\Users\bclerigo\AppData\Local\Temp\php81C3.tmp" 
const url = new URL(
    "http://localhost/api/patch_notes/1"
);

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

const body = new FormData();
body.append('title', 'b');
body.append('description', 'Eius et animi quos velit et.');
body.append('version', 'v');
body.append('type', 'feature');
body.append('is_published', '');
body.append('file', document.querySelector('input[name="file"]').files[0]);

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

Request      

PUT api/patch_notes/{id}

PATCH api/patch_notes/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the patch note. Example: 1

Body Parameters

title   string     

Must not be greater than 255 characters. Example: b

description   string     

Example: Eius et animi quos velit et.

version   string  optional    

Must not be greater than 50 characters. Example: v

type   string     

Example: feature

Must be one of:
  • feature
  • bugfix
  • security
  • performance
  • breaking
file   file     

Must be a file. Must not be greater than 10240 kilobytes. Example: C:\Users\bclerigo\AppData\Local\Temp\php81C3.tmp

is_published   boolean  optional    

Example: false

GET api/quality_assurance/{id}/filtered_week

Example request:
curl --request GET \
    --get "http://localhost/api/quality_assurance/architecto/filtered_week" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/quality_assurance/architecto/filtered_week"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/quality_assurance/{id}/filtered_week

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the quality assurance. Example: architecto

POST api/quality_assurance/download/attachments

Example request:
curl --request POST \
    "http://localhost/api/quality_assurance/download/attachments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/quality_assurance/download/attachments"
);

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

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

Request      

POST api/quality_assurance/download/attachments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/quality_assurance/auto_skip

Example request:
curl --request POST \
    "http://localhost/api/quality_assurance/auto_skip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/quality_assurance/auto_skip"
);

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

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

Request      

POST api/quality_assurance/auto_skip

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

PATCH api/quality_assurance/{id}/for_approval

Example request:
curl --request PATCH \
    "http://localhost/api/quality_assurance/architecto/for_approval" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/quality_assurance/architecto/for_approval"
);

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

let body = {
    "reason": "architecto"
};

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

Request      

PATCH api/quality_assurance/{id}/for_approval

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the quality assurance. Example: architecto

Body Parameters

reason   string     

Example: architecto

GET api/quality_assurance

Example request:
curl --request GET \
    --get "http://localhost/api/quality_assurance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"in_progress\"
}"

const url = new URL(
    "http://localhost/api/quality_assurance"
);

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

let body = {
    "status": "in_progress"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/quality_assurance

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: in_progress

Must be one of:
  • active
  • inactive
  • in_progress
  • completed
  • pending

POST api/quality_assurance

Example request:
curl --request POST \
    "http://localhost/api/quality_assurance" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "store_id=architecto"\
    --form "checklist_id=16"\
    --form "store_checklist_id=architecto"\
    --form "code=architecto"\
    --form "responses[][section_id]=16"\
    --form "responses[][question_id]=16"\
    --form "responses[][question_text]=architecto"\
    --form "responses[][question_type]=checkboxes"\
    --form "good_points=b"\
    --form "notes=n"\
    --form "store_duty_id[]=16"\
    --form "responses[][attachment][]=@C:\Users\bclerigo\AppData\Local\Temp\php81E4.tmp" 
const url = new URL(
    "http://localhost/api/quality_assurance"
);

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

const body = new FormData();
body.append('store_id', 'architecto');
body.append('checklist_id', '16');
body.append('store_checklist_id', 'architecto');
body.append('code', 'architecto');
body.append('responses[][section_id]', '16');
body.append('responses[][question_id]', '16');
body.append('responses[][question_text]', 'architecto');
body.append('responses[][question_type]', 'checkboxes');
body.append('good_points', 'b');
body.append('notes', 'n');
body.append('store_duty_id[]', '16');
body.append('responses[][attachment][]', document.querySelector('input[name="responses[][attachment][]"]').files[0]);

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

Request      

POST api/quality_assurance

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

store_id   string     

The id of an existing record in the stores table. Example: architecto

checklist_id   integer     

The id of an existing record in the checklists table. Example: 16

store_checklist_id   string     

The id of an existing record in the store_checklists table. Example: architecto

code   string     

The code of an existing record in the store_checklists table. Example: architecto

responses   object[]     

Must have at least 1 items.
section_id   integer     

The id of an existing record in the checklist_sections table. Example: 16

question_id   integer     

The id of an existing record in the checklist_questions table. Example: 16

question_text   string     

Example: architecto

question_type   string     

Example: checkboxes

Must be one of:
  • multiple_choice
  • checkboxes
  • paragraph
  • short_answer
  • dropdown
answer   string  optional    
remarks   string  optional    
attachment   file[]  optional    

Must be an image. Must not be greater than 10240 kilobytes.

store_visit   string  optional    
expired   string  optional    
condemned   string  optional    
good_points   string  optional    

Must not be greater than 2000 characters. Example: b

notes   string  optional    

Must not be greater than 2000 characters. Example: n

store_duty_id   integer[]     

The id of an existing record in the users table.

GET api/quality_assurance/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/quality_assurance/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/quality_assurance/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/quality_assurance/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the quality assurance. Example: architecto

PUT api/quality_assurance/{id}

Example request:
curl --request PUT \
    "http://localhost/api/quality_assurance/architecto" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "store_id=architecto"\
    --form "checklist_id=16"\
    --form "store_checklist_id=architecto"\
    --form "code=architecto"\
    --form "responses[][section_id]=16"\
    --form "responses[][question_id]=16"\
    --form "responses[][question_text]=architecto"\
    --form "responses[][question_type]=dropdown"\
    --form "good_points=b"\
    --form "notes=n"\
    --form "store_duty_id[]=16"\
    --form "responses[][attachment][]=@C:\Users\bclerigo\AppData\Local\Temp\php81E5.tmp" 
const url = new URL(
    "http://localhost/api/quality_assurance/architecto"
);

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

const body = new FormData();
body.append('store_id', 'architecto');
body.append('checklist_id', '16');
body.append('store_checklist_id', 'architecto');
body.append('code', 'architecto');
body.append('responses[][section_id]', '16');
body.append('responses[][question_id]', '16');
body.append('responses[][question_text]', 'architecto');
body.append('responses[][question_type]', 'dropdown');
body.append('good_points', 'b');
body.append('notes', 'n');
body.append('store_duty_id[]', '16');
body.append('responses[][attachment][]', document.querySelector('input[name="responses[][attachment][]"]').files[0]);

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

Request      

PUT api/quality_assurance/{id}

PATCH api/quality_assurance/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the quality assurance. Example: architecto

Body Parameters

store_id   string     

The id of an existing record in the stores table. Example: architecto

checklist_id   integer     

The id of an existing record in the checklists table. Example: 16

store_checklist_id   string     

The id of an existing record in the store_checklists table. Example: architecto

code   string     

The code of an existing record in the store_checklists table. Example: architecto

responses   object[]     

Must have at least 1 items.
section_id   integer     

The id of an existing record in the checklist_sections table. Example: 16

question_id   integer     

The id of an existing record in the checklist_questions table. Example: 16

question_text   string     

Example: architecto

question_type   string     

Example: dropdown

Must be one of:
  • multiple_choice
  • checkboxes
  • paragraph
  • short_answer
  • dropdown
answer   string  optional    
remarks   string  optional    
attachment   file[]  optional    

Must be an image. Must not be greater than 10240 kilobytes.

store_visit   string  optional    
expired   string  optional    
condemned   string  optional    
good_points   string  optional    

Must not be greater than 2000 characters. Example: b

notes   string  optional    

Must not be greater than 2000 characters. Example: n

store_duty_id   integer[]     

The id of an existing record in the users table.

GET api/region_area_head

Example request:
curl --request GET \
    --get "http://localhost/api/region_area_head" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_type\": \"region_head\"
}"

const url = new URL(
    "http://localhost/api/region_area_head"
);

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

let body = {
    "user_type": "region_head"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/region_area_head

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

user_type   string     

Example: region_head

Must be one of:
  • region_head
  • area_head

PATCH api/rating/{id}/toggle_archived

Example request:
curl --request PATCH \
    "http://localhost/api/rating/architecto/toggle_archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/rating/architecto/toggle_archived"
);

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

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

Request      

PATCH api/rating/{id}/toggle_archived

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the rating. Example: architecto

GET api/rating

Example request:
curl --request GET \
    --get "http://localhost/api/rating" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"inactive\"
}"

const url = new URL(
    "http://localhost/api/rating"
);

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

let body = {
    "status": "inactive"
};

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/rating

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

status   string     

Example: inactive

Must be one of:
  • active
  • inactive

POST api/rating

Example request:
curl --request POST \
    "http://localhost/api/rating" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rating\": 16,
    \"score\": 2
}"

const url = new URL(
    "http://localhost/api/rating"
);

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

let body = {
    "rating": 16,
    "score": 2
};

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

Request      

POST api/rating

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

rating   integer     

Example: 16

score   integer     

Must be between 1 and 100. Example: 2

GET api/rating/{id}

Example request:
curl --request GET \
    --get "http://localhost/api/rating/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/rating/architecto"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/rating/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the rating. Example: architecto

PUT api/rating/{id}

Example request:
curl --request PUT \
    "http://localhost/api/rating/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rating\": 16,
    \"score\": 2
}"

const url = new URL(
    "http://localhost/api/rating/architecto"
);

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

let body = {
    "rating": 16,
    "score": 2
};

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

Request      

PUT api/rating/{id}

PATCH api/rating/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the rating. Example: architecto

Body Parameters

rating   integer     

Example: 16

score   integer     

Must be between 1 and 100. Example: 2

PATCH api/approver_dashboard/{id}/approved

Example request:
curl --request PATCH \
    "http://localhost/api/approver_dashboard/architecto/approved" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/approver_dashboard/architecto/approved"
);

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

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

Request      

PATCH api/approver_dashboard/{id}/approved

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the approver dashboard. Example: architecto

PATCH api/approver_dashboard/{id}/rejected

Example request:
curl --request PATCH \
    "http://localhost/api/approver_dashboard/architecto/rejected" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/approver_dashboard/architecto/rejected"
);

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

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

Request      

PATCH api/approver_dashboard/{id}/rejected

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the approver dashboard. Example: architecto

GET api/approver_dashboard

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

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/approver_dashboard

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/export/region/area/store_grades

Example request:
curl --request GET \
    --get "http://localhost/api/export/region/area/store_grades" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/export/region/area/store_grades"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/export/region/area/store_grades

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/export/region/area/store_grades/per_week

Example request:
curl --request GET \
    --get "http://localhost/api/export/region/area/store_grades/per_week" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/export/region/area/store_grades/per_week"
);

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

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

Example response (401):

Show headers 
content-type: application/problem+json
cache-control: no-cache, private
access-control-allow-origin: *
 

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated!",
            "detail": "Unauthenticated."
        }
    ]
}

Request      

GET api/export/region/area/store_grades/per_week

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json