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/v1/auth/login

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\",
    \"hospital_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/auth/login"
);

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

let body = {
    "email": "qkunze@example.com",
    "password": "O[2UZ5ij-e\/dl4m{o,",
    "hospital_id": 17
};

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

Request      

POST api/v1/auth/login

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

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

password   string     

Example: O[2UZ5ij-e/dl4m{o,

hospital_id   integer  optional    

The id of an existing record in the hospitals table. Example: 17

POST api/v1/auth/refresh

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/auth/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"refresh_token\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/auth/refresh"
);

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

let body = {
    "refresh_token": "consequatur"
};

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

Request      

POST api/v1/auth/refresh

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

refresh_token   string     

Example: consequatur

GET api/v1/auth/me

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/auth/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/auth/me"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 117
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/auth/me

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/admin/hospitals

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/hospitals" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/hospitals"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 116
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/hospitals

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/admin/hospitals

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/hospitals" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"slug\": \"amniihfqcoynlazghdtqt\",
    \"settings\": {
        \"default_sla_hours\": 16,
        \"timezone\": \"Indian\\/Cocos\"
    },
    \"branch_name\": \"bajwbpilpmufinllwloau\",
    \"branch_code\": \"ydlsmsjuryvojcybzvrby\",
    \"department_name\": \"ickznkygloigmkwxphlva\",
    \"department_code\": \"zjrcnfbaqywuxhgjjmzux\",
    \"admin_name\": \"jubqouzswiwxtrkimfcat\",
    \"admin_email\": \"tromp.leanne@example.net\",
    \"admin_password\": \"mrazsroyjpxmqesedyghenqcopwvownkbamlnfngefbeilfzsyuxoezbdtabptcyyerevrljcbw\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/hospitals"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "slug": "amniihfqcoynlazghdtqt",
    "settings": {
        "default_sla_hours": 16,
        "timezone": "Indian\/Cocos"
    },
    "branch_name": "bajwbpilpmufinllwloau",
    "branch_code": "ydlsmsjuryvojcybzvrby",
    "department_name": "ickznkygloigmkwxphlva",
    "department_code": "zjrcnfbaqywuxhgjjmzux",
    "admin_name": "jubqouzswiwxtrkimfcat",
    "admin_email": "tromp.leanne@example.net",
    "admin_password": "mrazsroyjpxmqesedyghenqcopwvownkbamlnfngefbeilfzsyuxoezbdtabptcyyerevrljcbw"
};

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

Request      

POST api/v1/admin/hospitals

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

slug   string  optional    

Must match the regex /^[a-z0-9]+(?:-[a-z0-9]+)*$/. Must not be greater than 128 characters. Example: amniihfqcoynlazghdtqt

settings   object  optional    
default_sla_hours   integer  optional    

Must be at least 1. Must not be greater than 8760. Example: 16

timezone   string  optional    

Must not be greater than 64 characters. Example: Indian/Cocos

branch_name   string     

Must not be greater than 255 characters. Example: bajwbpilpmufinllwloau

branch_code   string  optional    

Must not be greater than 32 characters. Example: ydlsmsjuryvojcybzvrby

department_name   string  optional    

Must not be greater than 255 characters. Example: ickznkygloigmkwxphlva

department_code   string  optional    

Must not be greater than 32 characters. Example: zjrcnfbaqywuxhgjjmzux

admin_name   string     

Must not be greater than 255 characters. Example: jubqouzswiwxtrkimfcat

admin_email   string     

Must be a valid email address. Must not be greater than 255 characters. Example: tromp.leanne@example.net

admin_password   string     

Must be at least 8 characters. Example: mrazsroyjpxmqesedyghenqcopwvownkbamlnfngefbeilfzsyuxoezbdtabptcyyerevrljcbw

GET api/v1/master-data/service-departments

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/service-departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/service-departments"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 115
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/service-departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/service-departments/{serviceDepartment_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/service-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/service-departments/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 114
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/service-departments/{serviceDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

serviceDepartment_id   integer     

The ID of the serviceDepartment. Example: 1

GET api/v1/master-data/specialties

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/specialties" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/specialties"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 111
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/specialties

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/specialties/{specialty_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/specialties/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/specialties/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 110
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/specialties/{specialty_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

specialty_id   integer     

The ID of the specialty. Example: 1

GET api/v1/master-data/services

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/services" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/services"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 109
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/services

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/services/{service_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/services/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/services/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 108
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/services/{service_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

service_id   integer     

The ID of the service. Example: 1

GET api/v1/master-data/classifications

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/classifications" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/classifications"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 107
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/classifications

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/classifications/{classification_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/classifications/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/classifications/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 106
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/classifications/{classification_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

classification_id   integer     

The ID of the classification. Example: 1

GET api/v1/master-data/leakage-types

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/leakage-types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/leakage-types"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 105
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/leakage-types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/leakage-types/{leakage_type_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/leakage-types/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/leakage-types/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 104
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/leakage-types/{leakage_type_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

leakage_type_id   integer     

The ID of the leakage type. Example: 1

GET api/v1/master-data/policy-categories

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/policy-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/policy-categories"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 103
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/policy-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/policy-categories/{policy_category_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/policy-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/policy-categories/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 102
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/policy-categories/{policy_category_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

policy_category_id   integer     

The ID of the policy category. Example: 1

GET api/v1/master-data/action-owners

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/action-owners" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/action-owners"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 101
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/action-owners

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/action-owners/{action_owner_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/action-owners/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/action-owners/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 100
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/action-owners/{action_owner_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

action_owner_id   integer     

The ID of the action owner. Example: 1

GET api/v1/master-data/sop-policies

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/sop-policies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/sop-policies"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 99
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/sop-policies

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/sop-policies/{sop_policy_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/sop-policies/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/sop-policies/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 98
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/sop-policies/{sop_policy_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

sop_policy_id   integer     

The ID of the sop policy. Example: 1

GET api/v1/master-data/supply-categories

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-categories"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 97
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/supply-categories/{supplyCategory_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-categories/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 96
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-categories/{supplyCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCategory_id   integer     

The ID of the supplyCategory. Example: 1

GET api/v1/master-data/supply-subcategories

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-subcategories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-subcategories"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 95
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-subcategories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/supply-subcategories/{supplySubcategory_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-subcategories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-subcategories/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 94
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-subcategories/{supplySubcategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplySubcategory_id   integer     

The ID of the supplySubcategory. Example: 1

GET api/v1/master-data/supply-catalog-items

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-catalog-items" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-catalog-items"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 93
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-catalog-items

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/supply-catalog-items/{supplyCatalogItem_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/supply-catalog-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/supply-catalog-items/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 92
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/supply-catalog-items/{supplyCatalogItem_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCatalogItem_id   integer     

The ID of the supplyCatalogItem. Example: 1

POST api/v1/admin/master-data/service-departments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmu\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmu",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/service-departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: qxbajwbpilpmu

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/service-departments/{serviceDepartment_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmu\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmu",
    "is_active": true
};

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

Request      

PUT api/v1/admin/master-data/service-departments/{serviceDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

serviceDepartment_id   integer     

The ID of the serviceDepartment. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: qxbajwbpilpmu

is_active   boolean  optional    

Example: true

DELETE api/v1/admin/master-data/service-departments/{serviceDepartment_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/service-departments/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/service-departments/{serviceDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

serviceDepartment_id   integer     

The ID of the serviceDepartment. Example: 1

POST api/v1/admin/master-data/specialties

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/specialties

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/specialties/{specialty_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/specialties/{specialty_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

specialty_id   integer     

The ID of the specialty. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/specialties/{specialty_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/specialties/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/specialties/{specialty_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

specialty_id   integer     

The ID of the specialty. Example: 1

POST api/v1/admin/master-data/services

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/services" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_department_id\": 17,
    \"specialty_id\": 17,
    \"service_code\": \"mqeopfuudtdsufvyvddqa\",
    \"name_ar\": \"mniihfqcoynlazghdtqtq\",
    \"name_en\": \"xbajwbpilpmufinllwloa\",
    \"service_group\": \"uydlsmsjuryvojcybzvrb\",
    \"complexity\": 5,
    \"benchmark_unit_cost\": 29,
    \"benchmark_unit_revenue\": 7,
    \"benchmark_unit_margin_pct\": 11,
    \"quality_weight\": 88,
    \"duration_minutes\": 48,
    \"care_setting\": \"kygloigmkwxphlvazjrcn\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/services"
);

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

let body = {
    "service_department_id": 17,
    "specialty_id": 17,
    "service_code": "mqeopfuudtdsufvyvddqa",
    "name_ar": "mniihfqcoynlazghdtqtq",
    "name_en": "xbajwbpilpmufinllwloa",
    "service_group": "uydlsmsjuryvojcybzvrb",
    "complexity": 5,
    "benchmark_unit_cost": 29,
    "benchmark_unit_revenue": 7,
    "benchmark_unit_margin_pct": 11,
    "quality_weight": 88,
    "duration_minutes": 48,
    "care_setting": "kygloigmkwxphlvazjrcn",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/services

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

service_department_id   integer     

The id of an existing record in the service_departments table. Example: 17

specialty_id   integer     

The id of an existing record in the specialties table. Example: 17

service_code   string     

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 64 characters. Example: mqeopfuudtdsufvyvddqa

name_ar   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

name_en   string     

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

service_group   string  optional    

Must not be greater than 128 characters. Example: uydlsmsjuryvojcybzvrb

complexity   integer     

Must be at least 1. Must not be greater than 5. Example: 5

benchmark_unit_cost   number  optional    

Must be at least 0. Example: 29

benchmark_unit_revenue   number  optional    

Must be at least 0. Example: 7

benchmark_unit_margin_pct   number  optional    

Must be at least 0. Must not be greater than 100. Example: 11

quality_weight   number  optional    

Must be at least 0. Example: 88

duration_minutes   integer  optional    

Must be at least 0. Example: 48

care_setting   string  optional    

Must not be greater than 64 characters. Example: kygloigmkwxphlvazjrcn

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/services/{service_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/services/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_department_id\": 17,
    \"specialty_id\": 17,
    \"service_code\": \"mqeopfuudtdsufvyvddqa\",
    \"name_ar\": \"mniihfqcoynlazghdtqtq\",
    \"name_en\": \"xbajwbpilpmufinllwloa\",
    \"service_group\": \"uydlsmsjuryvojcybzvrb\",
    \"complexity\": 5,
    \"benchmark_unit_cost\": 29,
    \"benchmark_unit_revenue\": 7,
    \"benchmark_unit_margin_pct\": 11,
    \"quality_weight\": 88,
    \"duration_minutes\": 48,
    \"care_setting\": \"kygloigmkwxphlvazjrcn\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/services/1"
);

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

let body = {
    "service_department_id": 17,
    "specialty_id": 17,
    "service_code": "mqeopfuudtdsufvyvddqa",
    "name_ar": "mniihfqcoynlazghdtqtq",
    "name_en": "xbajwbpilpmufinllwloa",
    "service_group": "uydlsmsjuryvojcybzvrb",
    "complexity": 5,
    "benchmark_unit_cost": 29,
    "benchmark_unit_revenue": 7,
    "benchmark_unit_margin_pct": 11,
    "quality_weight": 88,
    "duration_minutes": 48,
    "care_setting": "kygloigmkwxphlvazjrcn",
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/services/{service_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

service_id   integer     

The ID of the service. Example: 1

Body Parameters

service_department_id   integer  optional    

The id of an existing record in the service_departments table. Example: 17

specialty_id   integer  optional    

The id of an existing record in the specialties table. Example: 17

service_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 64 characters. Example: mqeopfuudtdsufvyvddqa

name_ar   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

name_en   string  optional    

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

service_group   string  optional    

Must not be greater than 128 characters. Example: uydlsmsjuryvojcybzvrb

complexity   integer  optional    

Must be at least 1. Must not be greater than 5. Example: 5

benchmark_unit_cost   number  optional    

Must be at least 0. Example: 29

benchmark_unit_revenue   number  optional    

Must be at least 0. Example: 7

benchmark_unit_margin_pct   number  optional    

Must be at least 0. Must not be greater than 100. Example: 11

quality_weight   number  optional    

Must be at least 0. Example: 88

duration_minutes   integer  optional    

Must be at least 0. Example: 48

care_setting   string  optional    

Must not be greater than 64 characters. Example: kygloigmkwxphlvazjrcn

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/services/{service_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/services/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/services/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/services/{service_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

service_id   integer     

The ID of the service. Example: 1

POST api/v1/admin/master-data/classifications

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"profit_gap_threshold_min\": -99,
    \"profit_gap_threshold_max\": -99,
    \"color_code\": \"#4CD4ab\",
    \"description\": \"Minus voluptatem quisquam quibusdam sed.\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "profit_gap_threshold_min": -99,
    "profit_gap_threshold_max": -99,
    "color_code": "#4CD4ab",
    "description": "Minus voluptatem quisquam quibusdam sed."
};

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

Request      

POST api/v1/admin/master-data/classifications

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

profit_gap_threshold_min   number     

Must be between -100 and 100. Example: -99

profit_gap_threshold_max   number     

Must be between -100 and 100. Example: -99

color_code   string     

Must match the regex /^#[0-9A-Fa-f]{6}$/. Example: #4CD4ab

description   string  optional    

Must not be greater than 5000 characters. Example: Minus voluptatem quisquam quibusdam sed.

PUT api/v1/admin/master-data/classifications/{classification_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"profit_gap_threshold_min\": -99,
    \"profit_gap_threshold_max\": -99,
    \"color_code\": \"#4CD4ab\",
    \"description\": \"Minus voluptatem quisquam quibusdam sed.\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "profit_gap_threshold_min": -99,
    "profit_gap_threshold_max": -99,
    "color_code": "#4CD4ab",
    "description": "Minus voluptatem quisquam quibusdam sed."
};

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

Request      

PUT api/v1/admin/master-data/classifications/{classification_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

classification_id   integer     

The ID of the classification. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

profit_gap_threshold_min   number  optional    

Must be between -100 and 100. Example: -99

profit_gap_threshold_max   number  optional    

Must be between -100 and 100. Example: -99

color_code   string  optional    

Must match the regex /^#[0-9A-Fa-f]{6}$/. Example: #4CD4ab

description   string  optional    

Must not be greater than 5000 characters. Example: Minus voluptatem quisquam quibusdam sed.

DELETE api/v1/admin/master-data/classifications/{classification_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/classifications/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/classifications/{classification_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

classification_id   integer     

The ID of the classification. Example: 1

POST api/v1/admin/master-data/leakage-types

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"category\": \"qxbajwbpilpmufinllwlo\",
    \"default_weight\": 2,
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "category": "qxbajwbpilpmufinllwlo",
    "default_weight": 2,
    "is_active": false
};

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

Request      

POST api/v1/admin/master-data/leakage-types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

category   string     

Must not be greater than 128 characters. Example: qxbajwbpilpmufinllwlo

default_weight   number     

Must be at least 0. Example: 2

is_active   boolean  optional    

Example: false

PUT api/v1/admin/master-data/leakage-types/{leakage_type_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"category\": \"qxbajwbpilpmufinllwlo\",
    \"default_weight\": 2,
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "category": "qxbajwbpilpmufinllwlo",
    "default_weight": 2,
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/leakage-types/{leakage_type_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

leakage_type_id   integer     

The ID of the leakage type. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

category   string  optional    

Must not be greater than 128 characters. Example: qxbajwbpilpmufinllwlo

default_weight   number  optional    

Must be at least 0. Example: 2

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/leakage-types/{leakage_type_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/leakage-types/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/leakage-types/{leakage_type_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

leakage_type_id   integer     

The ID of the leakage type. Example: 1

POST api/v1/admin/master-data/policy-categories

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"description\": \"Necessitatibus architecto aut consequatur debitis et id.\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "description": "Necessitatibus architecto aut consequatur debitis et id.",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/policy-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

description   string  optional    

Must not be greater than 5000 characters. Example: Necessitatibus architecto aut consequatur debitis et id.

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/policy-categories/{policy_category_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"description\": \"Necessitatibus architecto aut consequatur debitis et id.\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "description": "Necessitatibus architecto aut consequatur debitis et id.",
    "is_active": true
};

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

Request      

PUT api/v1/admin/master-data/policy-categories/{policy_category_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

policy_category_id   integer     

The ID of the policy category. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

description   string  optional    

Must not be greater than 5000 characters. Example: Necessitatibus architecto aut consequatur debitis et id.

is_active   boolean  optional    

Example: true

DELETE api/v1/admin/master-data/policy-categories/{policy_category_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/policy-categories/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/policy-categories/{policy_category_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

policy_category_id   integer     

The ID of the policy category. Example: 1

POST api/v1/admin/master-data/action-owners

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"hierarchy_level\": 16,
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "hierarchy_level": 16,
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/action-owners

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

hierarchy_level   integer     

Must be at least 0. Must not be greater than 1000. Example: 16

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/action-owners/{action_owner_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"hierarchy_level\": 16,
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "hierarchy_level": 16,
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/action-owners/{action_owner_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

action_owner_id   integer     

The ID of the action owner. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

hierarchy_level   integer  optional    

Must be at least 0. Must not be greater than 1000. Example: 16

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/action-owners/{action_owner_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/action-owners/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/action-owners/{action_owner_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

action_owner_id   integer     

The ID of the action owner. Example: 1

POST api/v1/admin/master-data/sop-policies

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"policy_category_id\": 17,
    \"action_owner_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"policy_code\": \"xbajwbpilpmufinllwloa\",
    \"priority\": \"medium\",
    \"gap_to_best_practice\": 5,
    \"linked_process_family\": \"ydlsmsjuryvojcybzvrby\",
    \"implementation_notes\": \"ickznkygloigmkwxphlva\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies"
);

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

let body = {
    "policy_category_id": 17,
    "action_owner_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "policy_code": "xbajwbpilpmufinllwloa",
    "priority": "medium",
    "gap_to_best_practice": 5,
    "linked_process_family": "ydlsmsjuryvojcybzvrby",
    "implementation_notes": "ickznkygloigmkwxphlva",
    "is_active": false
};

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

Request      

POST api/v1/admin/master-data/sop-policies

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

policy_category_id   integer     

The id of an existing record in the policy_categories table. Example: 17

action_owner_id   integer     

The id of an existing record in the action_owners table. Example: 17

name_ar   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

policy_code   string     

Must not be greater than 64 characters. Example: xbajwbpilpmufinllwloa

priority   string     

Example: medium

Must be one of:
  • low
  • medium
  • high
gap_to_best_practice   integer     

Must be at least 1. Must not be greater than 5. Example: 5

linked_process_family   string     

Must not be greater than 255 characters. Example: ydlsmsjuryvojcybzvrby

implementation_notes   string     

Must not be greater than 10000 characters. Example: ickznkygloigmkwxphlva

is_active   boolean  optional    

Example: false

PUT api/v1/admin/master-data/sop-policies/{sop_policy_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"policy_category_id\": 17,
    \"action_owner_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"policy_code\": \"xbajwbpilpmufinllwloa\",
    \"priority\": \"medium\",
    \"gap_to_best_practice\": 5,
    \"linked_process_family\": \"ydlsmsjuryvojcybzvrby\",
    \"implementation_notes\": \"ickznkygloigmkwxphlva\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies/1"
);

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

let body = {
    "policy_category_id": 17,
    "action_owner_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "policy_code": "xbajwbpilpmufinllwloa",
    "priority": "medium",
    "gap_to_best_practice": 5,
    "linked_process_family": "ydlsmsjuryvojcybzvrby",
    "implementation_notes": "ickznkygloigmkwxphlva",
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/sop-policies/{sop_policy_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

sop_policy_id   integer     

The ID of the sop policy. Example: 1

Body Parameters

policy_category_id   integer  optional    

The id of an existing record in the policy_categories table. Example: 17

action_owner_id   integer  optional    

The id of an existing record in the action_owners table. Example: 17

name_ar   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

policy_code   string  optional    

Must not be greater than 64 characters. Example: xbajwbpilpmufinllwloa

priority   string  optional    

Example: medium

Must be one of:
  • low
  • medium
  • high
gap_to_best_practice   integer  optional    

Must be at least 1. Must not be greater than 5. Example: 5

linked_process_family   string  optional    

Must not be greater than 255 characters. Example: ydlsmsjuryvojcybzvrby

implementation_notes   string  optional    

Must not be greater than 10000 characters. Example: ickznkygloigmkwxphlva

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/sop-policies/{sop_policy_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/sop-policies/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/sop-policies/{sop_policy_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

sop_policy_id   integer     

The ID of the sop policy. Example: 1

POST api/v1/admin/master-data/supply-categories

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmufinllwlo\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmufinllwlo",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/supply-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name_ar   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 32 characters. Example: qxbajwbpilpmufinllwlo

is_active   boolean  optional    

Example: true

PUT api/v1/admin/master-data/supply-categories/{supplyCategory_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_ar\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmufinllwlo\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories/1"
);

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

let body = {
    "name_ar": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmufinllwlo",
    "is_active": true
};

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

Request      

PUT api/v1/admin/master-data/supply-categories/{supplyCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCategory_id   integer     

The ID of the supplyCategory. Example: 1

Body Parameters

name_ar   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 32 characters. Example: qxbajwbpilpmufinllwlo

is_active   boolean  optional    

Example: true

DELETE api/v1/admin/master-data/supply-categories/{supplyCategory_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-categories/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/supply-categories/{supplyCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCategory_id   integer     

The ID of the supplyCategory. Example: 1

POST api/v1/admin/master-data/supply-subcategories

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"supply_category_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"short_code\": \"xbajwbpilpmufinllwloa\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories"
);

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

let body = {
    "supply_category_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "short_code": "xbajwbpilpmufinllwloa",
    "is_active": false
};

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

Request      

POST api/v1/admin/master-data/supply-subcategories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

supply_category_id   integer     

The id of an existing record in the supply_categories table. Example: 17

name_ar   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 32 characters. Example: xbajwbpilpmufinllwloa

is_active   boolean  optional    

Example: false

PUT api/v1/admin/master-data/supply-subcategories/{supplySubcategory_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"supply_category_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"short_code\": \"xbajwbpilpmufinllwloa\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories/1"
);

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

let body = {
    "supply_category_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "short_code": "xbajwbpilpmufinllwloa",
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/supply-subcategories/{supplySubcategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplySubcategory_id   integer     

The ID of the supplySubcategory. Example: 1

Body Parameters

supply_category_id   integer  optional    

The id of an existing record in the supply_categories table. Example: 17

name_ar   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 32 characters. Example: xbajwbpilpmufinllwloa

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/supply-subcategories/{supplySubcategory_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-subcategories/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/supply-subcategories/{supplySubcategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplySubcategory_id   integer     

The ID of the supplySubcategory. Example: 1

POST api/v1/admin/master-data/supply-catalog-items

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"supply_subcategory_id\": 17,
    \"linked_service_department_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"item_code\": \"xbajwbpilpmufinllwloa\",
    \"unit\": \"uydlsmsjuryvojcybzvrb\",
    \"benchmark_unit_cost\": 84,
    \"min_qty\": 29,
    \"max_qty\": 7,
    \"criticality\": \"kznkygloigmkw\",
    \"vendor_type\": \"xphlvazjrcnfbaqywuxhg\",
    \"lead_days\": 34,
    \"notes\": \"jmzuxjubqouzswiwxtrki\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items"
);

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

let body = {
    "supply_subcategory_id": 17,
    "linked_service_department_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "item_code": "xbajwbpilpmufinllwloa",
    "unit": "uydlsmsjuryvojcybzvrb",
    "benchmark_unit_cost": 84,
    "min_qty": 29,
    "max_qty": 7,
    "criticality": "kznkygloigmkw",
    "vendor_type": "xphlvazjrcnfbaqywuxhg",
    "lead_days": 34,
    "notes": "jmzuxjubqouzswiwxtrki",
    "is_active": false
};

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

Request      

POST api/v1/admin/master-data/supply-catalog-items

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

supply_subcategory_id   integer     

The id of an existing record in the supply_subcategories table. Example: 17

linked_service_department_id   integer  optional    

The id of an existing record in the service_departments table. Example: 17

name_ar   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

item_code   string  optional    

Must not be greater than 64 characters. Example: xbajwbpilpmufinllwloa

unit   string  optional    

Must not be greater than 32 characters. Example: uydlsmsjuryvojcybzvrb

benchmark_unit_cost   number  optional    

Must be at least 0. Example: 84

min_qty   integer  optional    

Must be at least 0. Example: 29

max_qty   integer  optional    

Must be at least 0. Example: 7

criticality   string  optional    

Must not be greater than 16 characters. Example: kznkygloigmkw

vendor_type   string  optional    

Must not be greater than 32 characters. Example: xphlvazjrcnfbaqywuxhg

lead_days   integer  optional    

Must be at least 0. Example: 34

notes   string  optional    

Must not be greater than 2000 characters. Example: jmzuxjubqouzswiwxtrki

is_active   boolean  optional    

Example: false

PUT api/v1/admin/master-data/supply-catalog-items/{supplyCatalogItem_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"supply_subcategory_id\": 17,
    \"linked_service_department_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"item_code\": \"xbajwbpilpmufinllwloa\",
    \"unit\": \"uydlsmsjuryvojcybzvrb\",
    \"benchmark_unit_cost\": 84,
    \"min_qty\": 29,
    \"max_qty\": 7,
    \"criticality\": \"kznkygloigmkw\",
    \"vendor_type\": \"xphlvazjrcnfbaqywuxhg\",
    \"lead_days\": 34,
    \"notes\": \"jmzuxjubqouzswiwxtrki\",
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items/1"
);

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

let body = {
    "supply_subcategory_id": 17,
    "linked_service_department_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "item_code": "xbajwbpilpmufinllwloa",
    "unit": "uydlsmsjuryvojcybzvrb",
    "benchmark_unit_cost": 84,
    "min_qty": 29,
    "max_qty": 7,
    "criticality": "kznkygloigmkw",
    "vendor_type": "xphlvazjrcnfbaqywuxhg",
    "lead_days": 34,
    "notes": "jmzuxjubqouzswiwxtrki",
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/supply-catalog-items/{supplyCatalogItem_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCatalogItem_id   integer     

The ID of the supplyCatalogItem. Example: 1

Body Parameters

supply_subcategory_id   integer  optional    

The id of an existing record in the supply_subcategories table. Example: 17

linked_service_department_id   integer  optional    

The id of an existing record in the service_departments table. Example: 17

name_ar   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

item_code   string  optional    

Must not be greater than 64 characters. Example: xbajwbpilpmufinllwloa

unit   string  optional    

Must not be greater than 32 characters. Example: uydlsmsjuryvojcybzvrb

benchmark_unit_cost   number  optional    

Must be at least 0. Example: 84

min_qty   integer  optional    

Must be at least 0. Example: 29

max_qty   integer  optional    

Must be at least 0. Example: 7

criticality   string  optional    

Must not be greater than 16 characters. Example: kznkygloigmkw

vendor_type   string  optional    

Must not be greater than 32 characters. Example: xphlvazjrcnfbaqywuxhg

lead_days   integer  optional    

Must be at least 0. Example: 34

notes   string  optional    

Must not be greater than 2000 characters. Example: jmzuxjubqouzswiwxtrki

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/supply-catalog-items/{supplyCatalogItem_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/supply-catalog-items/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/supply-catalog-items/{supplyCatalogItem_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

supplyCatalogItem_id   integer     

The ID of the supplyCatalogItem. Example: 1

POST api/v1/auth/logout

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"refresh_token\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/auth/logout"
);

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

let body = {
    "refresh_token": "consequatur"
};

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

Request      

POST api/v1/auth/logout

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

refresh_token   string  optional    

Example: consequatur

GET api/v1/issue-statuses

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-statuses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-statuses"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 87
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-statuses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/issue-priorities

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-priorities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-priorities"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 86
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-priorities

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Create operational departments for this hospital from the master-departments catalog.

Skips master rows that already have a linked department in this hospital.

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/departments/import-from-master" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"master_department_ids\": [
        17
    ],
    \"active_only\": true,
    \"name_locale\": \"en\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/import-from-master"
);

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

let body = {
    "master_department_ids": [
        17
    ],
    "active_only": true,
    "name_locale": "en"
};

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

Request      

POST api/v1/departments/import-from-master

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

master_department_ids   integer[]  optional    

The id of an existing record in the master_departments table.

active_only   boolean  optional    

Example: true

name_locale   string  optional    

Example: en

Must be one of:
  • en
  • ar

GET api/v1/departments

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

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 85
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/departments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"code\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmu\",
    \"branch_id\": 17,
    \"master_department_id\": 17,
    \"actual_area_m2\": 45
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "code": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmu",
    "branch_id": 17,
    "master_department_id": 17,
    "actual_area_m2": 45
};

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

Request      

POST api/v1/departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

code   string  optional    

Must not be greater than 32 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: qxbajwbpilpmu

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

master_department_id   integer  optional    

The id of an existing record in the master_departments table. Example: 17

actual_area_m2   number  optional    

Must be at least 0. Example: 45

PUT api/v1/departments/{id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"code\": \"amniihfqcoynlazghdtqt\",
    \"short_code\": \"qxbajwbpilpmu\",
    \"branch_id\": 17,
    \"master_department_id\": 17,
    \"actual_area_m2\": 45
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "code": "amniihfqcoynlazghdtqt",
    "short_code": "qxbajwbpilpmu",
    "branch_id": 17,
    "master_department_id": 17,
    "actual_area_m2": 45
};

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

Request      

PUT api/v1/departments/{id}

PATCH api/v1/departments/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the department. Example: 1

Body Parameters

name   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

code   string  optional    

Must not be greater than 32 characters. Example: amniihfqcoynlazghdtqt

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: qxbajwbpilpmu

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

master_department_id   integer  optional    

The id of an existing record in the master_departments table. Example: 17

actual_area_m2   number  optional    

Must be at least 0. Example: 45

DELETE api/v1/departments/{id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1"
);

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


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

Request      

DELETE api/v1/departments/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the department. Example: 1

GET api/v1/catalog/master-departments

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/catalog/master-departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/catalog/master-departments"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 84
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/catalog/master-departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/catalog/master-units

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/catalog/master-units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/catalog/master-units"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 83
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/catalog/master-units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/departments/{department_id}/units

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/departments/1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1/units"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 82
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/departments/{department_id}/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

department_id   integer     

The ID of the department. Example: 1

POST api/v1/departments/{department_id}/units

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/departments/1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"master_unit_id\": 17,
    \"is_enabled\": false,
    \"actual_area_m2\": 45,
    \"notes\": \"qeopfuudtdsufvyvddqam\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1/units"
);

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

let body = {
    "master_unit_id": 17,
    "is_enabled": false,
    "actual_area_m2": 45,
    "notes": "qeopfuudtdsufvyvddqam"
};

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

Request      

POST api/v1/departments/{department_id}/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

department_id   integer     

The ID of the department. Example: 1

Body Parameters

master_unit_id   integer     

The id of an existing record in the master_units table. Example: 17

is_enabled   boolean  optional    

Example: false

actual_area_m2   number  optional    

Must be at least 0. Example: 45

notes   string  optional    

Must not be greater than 5000 characters. Example: qeopfuudtdsufvyvddqam

PUT api/v1/departments/{department_id}/units/{department_unit_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/departments/1/units/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"master_unit_id\": 17,
    \"is_enabled\": true,
    \"actual_area_m2\": 45,
    \"notes\": \"qeopfuudtdsufvyvddqam\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1/units/consequatur"
);

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

let body = {
    "master_unit_id": 17,
    "is_enabled": true,
    "actual_area_m2": 45,
    "notes": "qeopfuudtdsufvyvddqam"
};

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

Request      

PUT api/v1/departments/{department_id}/units/{department_unit_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

department_id   integer     

The ID of the department. Example: 1

department_unit_id   string     

The ID of the department unit. Example: consequatur

Body Parameters

master_unit_id   integer  optional    

The id of an existing record in the master_units table. Example: 17

is_enabled   boolean  optional    

Example: true

actual_area_m2   number  optional    

Must be at least 0. Example: 45

notes   string  optional    

Must not be greater than 5000 characters. Example: qeopfuudtdsufvyvddqam

DELETE api/v1/departments/{department_id}/units/{department_unit_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/departments/1/units/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/departments/1/units/consequatur"
);

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


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

Request      

DELETE api/v1/departments/{department_id}/units/{department_unit_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

department_id   integer     

The ID of the department. Example: 1

department_unit_id   string     

The ID of the department unit. Example: consequatur

GET api/v1/hospitals/{hospital_id}/units

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/hospitals/1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospitals/1/units"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 81
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/hospitals/{hospital_id}/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

hospital_id   integer     

The ID of the hospital. Example: 1

POST api/v1/hospitals/{hospital_id}/units

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/hospitals/1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": 73,
    \"units\": [
        {
            \"master_unit_id\": 17,
            \"rooms\": 13,
            \"beds\": 16,
            \"target_occupancy_pct\": 5,
            \"current_occupancy_pct\": 14,
            \"avg_los_days\": 55
        }
    ]
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospitals/1/units"
);

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

let body = {
    "version": 73,
    "units": [
        {
            "master_unit_id": 17,
            "rooms": 13,
            "beds": 16,
            "target_occupancy_pct": 5,
            "current_occupancy_pct": 14,
            "avg_los_days": 55
        }
    ]
};

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

Request      

POST api/v1/hospitals/{hospital_id}/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

hospital_id   integer     

The ID of the hospital. Example: 1

Body Parameters

version   integer     

Must be at least 0. Example: 73

units   object[]     
master_unit_id   integer     

The id of an existing record in the master_units table. Example: 17

rooms   integer     

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

beds   integer     

Must be at least 0. Must not be greater than 100000. Example: 16

target_occupancy_pct   number     

Must be at least 0. Must not be greater than 100. Example: 5

current_occupancy_pct   number     

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

avg_los_days   number     

Must be at least 0. Example: 55

GET api/v1/hospitals/{hospital_id}/departments

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/hospitals/1/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospitals/1/departments"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 80
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/hospitals/{hospital_id}/departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

hospital_id   integer     

The ID of the hospital. Example: 1

POST api/v1/hospitals/{hospital_id}/departments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/hospitals/1/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": 73,
    \"departments\": [
        {
            \"master_unit_id\": 17,
            \"specialties\": [
                {
                    \"specialty_id\": 17,
                    \"clinic_rooms\": 13,
                    \"sessions_per_week\": 16,
                    \"avg_visits_per_room_per_day\": 16,
                    \"current_wait_days\": 14
                }
            ]
        }
    ]
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospitals/1/departments"
);

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

let body = {
    "version": 73,
    "departments": [
        {
            "master_unit_id": 17,
            "specialties": [
                {
                    "specialty_id": 17,
                    "clinic_rooms": 13,
                    "sessions_per_week": 16,
                    "avg_visits_per_room_per_day": 16,
                    "current_wait_days": 14
                }
            ]
        }
    ]
};

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

Request      

POST api/v1/hospitals/{hospital_id}/departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

hospital_id   integer     

The ID of the hospital. Example: 1

Body Parameters

version   integer     

Must be at least 0. Example: 73

departments   object[]     
master_unit_id   integer     

The id of an existing record in the master_units table. Example: 17

specialties   object[]     
specialty_id   integer     

The id of an existing record in the specialties table. Example: 17

clinic_rooms   integer     

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

sessions_per_week   integer     

Must be at least 0. Must not be greater than 10000. Example: 16

avg_visits_per_room_per_day   number     

Must be at least 0. Example: 16

current_wait_days   integer     

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

GET api/v1/hospital/master-units/{master_unit_id}/workflow

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 79
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/hospital/master-units/{master_unit_id}/workflow

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

PUT api/v1/hospital/master-units/{master_unit_id}/workflow

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"workflow\": {
        \"code\": \"vmqeopfuudtdsufvyvddq\",
        \"name_en\": \"amniihfqcoynlazghdtqt\",
        \"name_ar\": \"qxbajwbpilpmufinllwlo\",
        \"steps\": [
            {
                \"step_name_en\": \"vmqeopfuudtdsufvyvddq\",
                \"step_name_ar\": \"amniihfqcoynlazghdtqt\",
                \"step_type\": \"qxbajwbpilpmufinllwlo\",
                \"is_required\": false,
                \"requires_master_department_id\": 17,
                \"requires_master_unit_id\": 17
            }
        ]
    }
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow"
);

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

let body = {
    "workflow": {
        "code": "vmqeopfuudtdsufvyvddq",
        "name_en": "amniihfqcoynlazghdtqt",
        "name_ar": "qxbajwbpilpmufinllwlo",
        "steps": [
            {
                "step_name_en": "vmqeopfuudtdsufvyvddq",
                "step_name_ar": "amniihfqcoynlazghdtqt",
                "step_type": "qxbajwbpilpmufinllwlo",
                "is_required": false,
                "requires_master_department_id": 17,
                "requires_master_unit_id": 17
            }
        ]
    }
};

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

Request      

PUT api/v1/hospital/master-units/{master_unit_id}/workflow

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

Body Parameters

workflow   object     
code   string     

Must not be greater than 32 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

name_ar   string  optional    

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

steps   object[]     

Must have at least 1 items.

step_name_en   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

step_name_ar   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

step_type   string  optional    

Must not be greater than 64 characters. Example: qxbajwbpilpmufinllwlo

is_required   boolean  optional    

Example: false

requires_master_department_id   integer  optional    

The id of an existing record in the master_departments table. Example: 17

requires_master_unit_id   integer  optional    

The id of an existing record in the master_units table. Example: 17

DELETE api/v1/hospital/master-units/{master_unit_id}/workflow

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/hospital/master-units/1/workflow"
);

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


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

Request      

DELETE api/v1/hospital/master-units/{master_unit_id}/workflow

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

GET api/v1/issue-categories

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-categories"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 78
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/issue-categories

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issue-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"module_type\": \"vmqeopfuudtdsufvyvddq\",
    \"name\": \"amniihfqcoynlazghdtqt\",
    \"slug\": \"qxbajwbpilpmufinllwlo\",
    \"parent_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-categories"
);

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

let body = {
    "module_type": "vmqeopfuudtdsufvyvddq",
    "name": "amniihfqcoynlazghdtqt",
    "slug": "qxbajwbpilpmufinllwlo",
    "parent_id": 17
};

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

Request      

POST api/v1/issue-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

module_type   string     

Must not be greater than 32 characters. Example: vmqeopfuudtdsufvyvddq

name   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

slug   string  optional    

Must not be greater than 128 characters. Example: qxbajwbpilpmufinllwlo

parent_id   integer  optional    

The id of an existing record in the issue_categories table. Example: 17

GET api/v1/issue-categories/{issueCategory_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-categories/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 77
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-categories/{issueCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueCategory_id   integer     

The ID of the issueCategory. Example: 1

PUT api/v1/issue-categories/{issueCategory_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/issue-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"module_type\": \"vmqeopfuudtdsufvyvddq\",
    \"name\": \"amniihfqcoynlazghdtqt\",
    \"slug\": \"qxbajwbpilpmufinllwlo\",
    \"parent_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-categories/1"
);

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

let body = {
    "module_type": "vmqeopfuudtdsufvyvddq",
    "name": "amniihfqcoynlazghdtqt",
    "slug": "qxbajwbpilpmufinllwlo",
    "parent_id": 17
};

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

Request      

PUT api/v1/issue-categories/{issueCategory_id}

PATCH api/v1/issue-categories/{issueCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueCategory_id   integer     

The ID of the issueCategory. Example: 1

Body Parameters

module_type   string  optional    

Must not be greater than 32 characters. Example: vmqeopfuudtdsufvyvddq

name   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

slug   string  optional    

Must not be greater than 128 characters. Example: qxbajwbpilpmufinllwlo

parent_id   integer  optional    

The id of an existing record in the issue_categories table. Example: 17

DELETE api/v1/issue-categories/{issueCategory_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/issue-categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-categories/1"
);

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


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

Request      

DELETE api/v1/issue-categories/{issueCategory_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueCategory_id   integer     

The ID of the issueCategory. Example: 1

GET api/v1/issue-tags

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-tags" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-tags"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 76
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-tags

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/issue-tags

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issue-tags" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"slug\": \"amniihfqcoynlazghdtqt\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-tags"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "slug": "amniihfqcoynlazghdtqt"
};

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

Request      

POST api/v1/issue-tags

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

slug   string  optional    

Must not be greater than 128 characters. Example: amniihfqcoynlazghdtqt

GET api/v1/issue-tags/{issueTag_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issue-tags/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-tags/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 75
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issue-tags/{issueTag_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueTag_id   integer     

The ID of the issueTag. Example: 1

PUT api/v1/issue-tags/{issueTag_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/issue-tags/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"slug\": \"amniihfqcoynlazghdtqt\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-tags/1"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "slug": "amniihfqcoynlazghdtqt"
};

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

Request      

PUT api/v1/issue-tags/{issueTag_id}

PATCH api/v1/issue-tags/{issueTag_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueTag_id   integer     

The ID of the issueTag. Example: 1

Body Parameters

name   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

slug   string  optional    

Must not be greater than 128 characters. Example: amniihfqcoynlazghdtqt

DELETE api/v1/issue-tags/{issueTag_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/issue-tags/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issue-tags/1"
);

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


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

Request      

DELETE api/v1/issue-tags/{issueTag_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issueTag_id   integer     

The ID of the issueTag. Example: 1

GET api/v1/patients

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

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 74
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/patients

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/patients

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/patients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mrn\": \"consequatur\",
    \"first_name\": \"mqeopfuudtdsufvyvddqa\",
    \"last_name\": \"mniihfqcoynlazghdtqtq\",
    \"date_of_birth\": \"2026-04-18T19:18:09\",
    \"branch_id\": 17,
    \"notes\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/patients"
);

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

let body = {
    "mrn": "consequatur",
    "first_name": "mqeopfuudtdsufvyvddqa",
    "last_name": "mniihfqcoynlazghdtqtq",
    "date_of_birth": "2026-04-18T19:18:09",
    "branch_id": 17,
    "notes": "consequatur"
};

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

Request      

POST api/v1/patients

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

mrn   string  optional    

Example: consequatur

first_name   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

last_name   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

date_of_birth   string  optional    

Must be a valid date. Example: 2026-04-18T19:18:09

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

notes   string  optional    

Example: consequatur

PUT api/v1/patients/{patient_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/patients/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mrn\": \"consequatur\",
    \"first_name\": \"mqeopfuudtdsufvyvddqa\",
    \"last_name\": \"mniihfqcoynlazghdtqtq\",
    \"date_of_birth\": \"2026-04-18T19:18:09\",
    \"branch_id\": 17,
    \"notes\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/patients/17"
);

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

let body = {
    "mrn": "consequatur",
    "first_name": "mqeopfuudtdsufvyvddqa",
    "last_name": "mniihfqcoynlazghdtqtq",
    "date_of_birth": "2026-04-18T19:18:09",
    "branch_id": 17,
    "notes": "consequatur"
};

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

Request      

PUT api/v1/patients/{patient_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

patient_id   integer     

The ID of the patient. Example: 17

Body Parameters

mrn   string  optional    

Example: consequatur

first_name   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

last_name   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

date_of_birth   string  optional    

Must be a valid date. Example: 2026-04-18T19:18:09

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

notes   string  optional    

Example: consequatur

GET api/v1/issues

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

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 73
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/issues

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/issues

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"issueable_type\": \"consequatur\",
    \"issueable_id\": 17,
    \"category_id\": 17,
    \"priority_id\": 17,
    \"status_id\": 17,
    \"title\": \"mqeopfuudtdsufvyvddqa\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"branch_id\": 17,
    \"department_id\": 17,
    \"assigned_to\": 17,
    \"tag_ids\": [
        17
    ]
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues"
);

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

let body = {
    "issueable_type": "consequatur",
    "issueable_id": 17,
    "category_id": 17,
    "priority_id": 17,
    "status_id": 17,
    "title": "mqeopfuudtdsufvyvddqa",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "branch_id": 17,
    "department_id": 17,
    "assigned_to": 17,
    "tag_ids": [
        17
    ]
};

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

Request      

POST api/v1/issues

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

issueable_type   string     

Example: consequatur

issueable_id   integer     

Example: 17

category_id   integer     

Example: 17

priority_id   integer     

The id of an existing record in the issue_priorities table. Example: 17

status_id   integer  optional    

The id of an existing record in the issue_statuses table. Example: 17

title   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

description   string  optional    

Example: Dolores dolorum amet iste laborum eius est dolor.

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

department_id   integer  optional    

The id of an existing record in the departments table. Example: 17

assigned_to   integer  optional    

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

tag_ids   integer[]  optional    

GET api/v1/issues/{issue_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issues/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17"
);

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


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

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 72
access-control-allow-origin: *
 

{
    "message": "No query results for model [App\\Models\\Issue] 17"
}
 

Request      

GET api/v1/issues/{issue_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

PUT api/v1/issues/{issue_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/issues/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"branch_id\": 17,
    \"department_id\": 17,
    \"category_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "branch_id": 17,
    "department_id": 17,
    "category_id": 17
};

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

Request      

PUT api/v1/issues/{issue_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

title   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional    

Example: Dolores dolorum amet iste laborum eius est dolor.

branch_id   integer  optional    

The id of an existing record in the branches table. Example: 17

department_id   integer  optional    

The id of an existing record in the departments table. Example: 17

category_id   integer  optional    

The id of an existing record in the issue_categories table. Example: 17

DELETE api/v1/issues/{issue_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/issues/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17"
);

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


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

Request      

DELETE api/v1/issues/{issue_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

POST api/v1/issues/{issue_id}/assign

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/assign" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assigned_to\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/assign"
);

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

let body = {
    "assigned_to": 17
};

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

Request      

POST api/v1/issues/{issue_id}/assign

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

assigned_to   integer  optional    

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

POST api/v1/issues/{issue_id}/status

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/status"
);

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

let body = {
    "status_id": 17
};

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

Request      

POST api/v1/issues/{issue_id}/status

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

status_id   integer     

The id of an existing record in the issue_statuses table. Example: 17

POST api/v1/issues/{issue_id}/priority

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/priority" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"priority_id\": 17
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/priority"
);

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

let body = {
    "priority_id": 17
};

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

Request      

POST api/v1/issues/{issue_id}/priority

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

priority_id   integer     

The id of an existing record in the issue_priorities table. Example: 17

GET api/v1/issues/{issue_id}/comments

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issues/17/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/comments"
);

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


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

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 71
access-control-allow-origin: *
 

{
    "message": "No query results for model [App\\Models\\Issue] 17"
}
 

Request      

GET api/v1/issues/{issue_id}/comments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

POST api/v1/issues/{issue_id}/comments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\",
    \"is_internal\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/comments"
);

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

let body = {
    "body": "consequatur",
    "is_internal": true
};

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

Request      

POST api/v1/issues/{issue_id}/comments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

body   string     

Example: consequatur

is_internal   boolean  optional    

Example: true

POST api/v1/issues/{issue_id}/attachments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/attachments" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@C:\Users\Misoliman\AppData\Local\Temp\phpC771.tmp" 
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/attachments"
);

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

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

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

Request      

POST api/v1/issues/{issue_id}/attachments

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

file   file     

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

POST api/v1/issues/{issue_id}/solutions

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/issues/17/solutions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"summary\": \"consequatur\",
    \"actions_taken\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/solutions"
);

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

let body = {
    "summary": "consequatur",
    "actions_taken": "consequatur"
};

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

Request      

POST api/v1/issues/{issue_id}/solutions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

Body Parameters

summary   string     

Example: consequatur

actions_taken   string  optional    

Example: consequatur

GET api/v1/issues/{issue_id}/timeline

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/issues/17/timeline" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/issues/17/timeline"
);

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


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

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 70
access-control-allow-origin: *
 

{
    "message": "No query results for model [App\\Models\\Issue] 17"
}
 

Request      

GET api/v1/issues/{issue_id}/timeline

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

issue_id   integer     

The ID of the issue. Example: 17

GET api/v1/reports/summary

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/reports/summary" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/reports/summary"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 69
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/reports/summary

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/reports/trends" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/reports/trends"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 68
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

GET api/v1/reports/top-categories

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/reports/top-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/reports/top-categories"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 67
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/reports/top-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/reports/export

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/reports/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/reports/export"
);

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


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

Request      

POST api/v1/reports/export

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/exports/{reportExport_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/reports/exports/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/reports/exports/17"
);

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


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

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 66
access-control-allow-origin: *
 

{
    "message": "No query results for model [App\\Models\\ReportExport] 17"
}
 

Request      

GET api/v1/reports/exports/{reportExport_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

reportExport_id   integer     

The ID of the reportExport. Example: 17

GET api/v1/admin/users/meta

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/users/meta" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users/meta"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 65
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/users/meta

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/admin/users

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"vmqeopfuudtdsufvyvddq\",
    \"role\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"disabled\",
    \"page\": 56,
    \"per_page\": 23
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users"
);

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

let body = {
    "q": "vmqeopfuudtdsufvyvddq",
    "role": "amniihfqcoynlazghdtqt",
    "status": "disabled",
    "page": 56,
    "per_page": 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
x-ratelimit-limit: 120
x-ratelimit-remaining: 64
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

q   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

role   string  optional    

Must not be greater than 125 characters. Example: amniihfqcoynlazghdtqt

status   string  optional    

Example: disabled

Must be one of:
  • active
  • disabled
page   integer  optional    

Must be at least 1. Example: 56

per_page   integer  optional    

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

POST api/v1/admin/users

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"password\": \"4[*UyPJ\\\"}6\",
    \"role\": \"hdtqtqxbajwbpilpmufin\",
    \"disabled\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "password": "4[*UyPJ\"}6",
    "role": "hdtqtqxbajwbpilpmufin",
    "disabled": false
};

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

Request      

POST api/v1/admin/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string     

Must be a valid email address. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

password   string     

Must be at least 8 characters. Example: 4[*UyPJ"}6

role   string  optional    

Must not be greater than 125 characters. Example: hdtqtqxbajwbpilpmufin

disabled   boolean  optional    

Example: false

PUT api/v1/admin/users/{user_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"role\": \"hfqcoynlazghdtqtqxbaj\",
    \"disabled\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users/1"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "role": "hfqcoynlazghdtqtqxbaj",
    "disabled": true
};

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

Request      

PUT api/v1/admin/users/{user_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

user_id   integer     

The ID of the user. Example: 1

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string     

Must be a valid email address. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

role   string  optional    

Must not be greater than 125 characters. Example: hfqcoynlazghdtqtqxbaj

disabled   boolean  optional    

Example: true

DELETE api/v1/admin/users/{user_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users/1"
);

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


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

Request      

DELETE api/v1/admin/users/{user_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

user_id   integer     

The ID of the user. Example: 1

GET api/v1/admin/users/export

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/users/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"vmqeopfuudtdsufvyvddq\",
    \"role\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"disabled\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/users/export"
);

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

let body = {
    "q": "vmqeopfuudtdsufvyvddq",
    "role": "amniihfqcoynlazghdtqt",
    "status": "disabled"
};

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
x-ratelimit-limit: 120
x-ratelimit-remaining: 63
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/users/export

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

q   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

role   string  optional    

Must not be greater than 125 characters. Example: amniihfqcoynlazghdtqt

status   string  optional    

Example: disabled

Must be one of:
  • active
  • disabled

GET api/v1/admin/settings/hospital

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/settings/hospital" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/settings/hospital"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 62
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/settings/hospital

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

PUT api/v1/admin/settings/hospital

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/settings/hospital" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"official_name\": \"amniihfqcoynlazghdtqt\",
    \"type_classification\": \"Primary\",
    \"region\": \"qxbajwbpilpmufinllwlo\",
    \"ownership_type\": \"Public\",
    \"total_beds\": 2,
    \"case_mix\": [
        21
    ],
    \"settings\": {
        \"default_sla_hours\": 21,
        \"timezone\": \"Asia\\/Almaty\"
    }
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/settings/hospital"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "official_name": "amniihfqcoynlazghdtqt",
    "type_classification": "Primary",
    "region": "qxbajwbpilpmufinllwlo",
    "ownership_type": "Public",
    "total_beds": 2,
    "case_mix": [
        21
    ],
    "settings": {
        "default_sla_hours": 21,
        "timezone": "Asia\/Almaty"
    }
};

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

Request      

PUT api/v1/admin/settings/hospital

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

official_name   string  optional    

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

type_classification   string  optional    

Example: Primary

Must be one of:
  • Primary
  • Secondary
  • Tertiary General Hospital
  • Specialty Hospital
  • Teaching Hospital
region   string  optional    

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

ownership_type   string  optional    

Example: Public

Must be one of:
  • Public
  • Private
  • PPP
total_beds   integer  optional    

Must be at least 0. Example: 2

case_mix   number[]  optional    

Must be at least 0. Must not be greater than 100.

settings   object     
default_sla_hours   integer  optional    

Must be at least 1. Must not be greater than 8760. Example: 21

timezone   string  optional    

Must not be greater than 64 characters. Example: Asia/Almaty

GET api/v1/admin/hospital/export/json

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/hospital/export/json" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/hospital/export/json"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 61
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/hospital/export/json

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/admin/hospital/export/csv

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/hospital/export/csv" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/hospital/export/csv"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 60
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/hospital/export/csv

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/admin/hospital/import

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/hospital/import" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@C:\Users\Misoliman\AppData\Local\Temp\phpC967.tmp" 
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/hospital/import"
);

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

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

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

Request      

POST api/v1/admin/hospital/import

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

file   file     

Must be a file. Example: C:\Users\Misoliman\AppData\Local\Temp\phpC967.tmp

GET api/v1/admin/pages

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/pages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"vmqeopfuudtdsufvyvddq\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/pages"
);

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

let body = {
    "q": "vmqeopfuudtdsufvyvddq"
};

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
x-ratelimit-limit: 120
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/pages

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

q   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

POST api/v1/admin/pages

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/pages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"slug\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"published\",
    \"body\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/pages"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "slug": "amniihfqcoynlazghdtqt",
    "status": "published",
    "body": "consequatur"
};

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

Request      

POST api/v1/admin/pages

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

title   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

slug   string     

Must not be greater than 160 characters. Example: amniihfqcoynlazghdtqt

status   string     

Example: published

Must be one of:
  • draft
  • published
body   string  optional    

Example: consequatur

PUT api/v1/admin/pages/{page_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/pages/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"slug\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"published\",
    \"body\": \"consequatur\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/pages/17"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "slug": "amniihfqcoynlazghdtqt",
    "status": "published",
    "body": "consequatur"
};

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

Request      

PUT api/v1/admin/pages/{page_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

page_id   integer     

The ID of the page. Example: 17

Body Parameters

title   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

slug   string     

Must not be greater than 160 characters. Example: amniihfqcoynlazghdtqt

status   string     

Example: published

Must be one of:
  • draft
  • published
body   string  optional    

Example: consequatur

DELETE api/v1/admin/pages/{page_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/pages/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/pages/17"
);

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


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

Request      

DELETE api/v1/admin/pages/{page_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

page_id   integer     

The ID of the page. Example: 17

GET api/v1/admin/pages/export

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/pages/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"vmqeopfuudtdsufvyvddq\"
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/pages/export"
);

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

let body = {
    "q": "vmqeopfuudtdsufvyvddq"
};

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
x-ratelimit-limit: 120
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/pages/export

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

q   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

Master Data

Reference catalog for hospital department types and benchmark areas (m²). Operational hospital departments may link via departments.master_department_id.

Read: GET /api/v1/master-data/... with permission master_data.view.

Write: POST|PUT|DELETE /api/v1/admin/master-data/... requires super admin and master_data.manage (no tenant header).

GET api/v1/master-data/master-departments

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/master-departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/master-departments"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 113
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/master-departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/master-departments/{masterDepartment_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/master-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/master-departments/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 112
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/master-departments/{masterDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

masterDepartment_id   integer     

The ID of the masterDepartment. Example: 1

GET api/v1/master-data/master-units

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/master-units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/master-units"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 91
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/master-units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/master-data/master-units/{master_unit_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/master-data/master-units/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/master-data/master-units/1"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 90
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/master-data/master-units/{master_unit_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

POST api/v1/admin/master-data/master-departments

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_department_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"short_code\": \"xbajwbpilpmuf\",
    \"benchmark_area_m2\": 28,
    \"std_m2_per_unit\": 48,
    \"min_core_m2\": 39,
    \"driver_description\": \"lwloauydlsmsjuryvojcy\",
    \"reference_driver_units\": 2,
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments"
);

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

let body = {
    "service_department_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "short_code": "xbajwbpilpmuf",
    "benchmark_area_m2": 28,
    "std_m2_per_unit": 48,
    "min_core_m2": 39,
    "driver_description": "lwloauydlsmsjuryvojcy",
    "reference_driver_units": 2,
    "is_active": false
};

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

Request      

POST api/v1/admin/master-data/master-departments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

service_department_id   integer  optional    

The id of an existing record in the service_departments table. Example: 17

name_ar   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string     

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: xbajwbpilpmuf

benchmark_area_m2   number     

Must be at least 0.01. Example: 28

std_m2_per_unit   number  optional    

Must be at least 0.01. Example: 48

min_core_m2   number  optional    

Must be at least 0. Example: 39

driver_description   string  optional    

Must not be greater than 2000 characters. Example: lwloauydlsmsjuryvojcy

reference_driver_units   integer  optional    

Must be at least 0. Must not be greater than 999999. Example: 2

is_active   boolean  optional    

Example: false

PUT api/v1/admin/master-data/master-departments/{masterDepartment_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_department_id\": 17,
    \"name_ar\": \"mqeopfuudtdsufvyvddqa\",
    \"name_en\": \"mniihfqcoynlazghdtqtq\",
    \"short_code\": \"xbajwbpilpmuf\",
    \"benchmark_area_m2\": 28,
    \"std_m2_per_unit\": 48,
    \"min_core_m2\": 39,
    \"driver_description\": \"lwloauydlsmsjuryvojcy\",
    \"reference_driver_units\": 2,
    \"is_active\": false
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments/1"
);

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

let body = {
    "service_department_id": 17,
    "name_ar": "mqeopfuudtdsufvyvddqa",
    "name_en": "mniihfqcoynlazghdtqtq",
    "short_code": "xbajwbpilpmuf",
    "benchmark_area_m2": 28,
    "std_m2_per_unit": 48,
    "min_core_m2": 39,
    "driver_description": "lwloauydlsmsjuryvojcy",
    "reference_driver_units": 2,
    "is_active": false
};

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

Request      

PUT api/v1/admin/master-data/master-departments/{masterDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

masterDepartment_id   integer     

The ID of the masterDepartment. Example: 1

Body Parameters

service_department_id   integer  optional    

The id of an existing record in the service_departments table. Example: 17

name_ar   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name_en   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

short_code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 16 characters. Example: xbajwbpilpmuf

benchmark_area_m2   number  optional    

Must be at least 0.01. Example: 28

std_m2_per_unit   number  optional    

Must be at least 0.01. Example: 48

min_core_m2   number  optional    

Must be at least 0. Example: 39

driver_description   string  optional    

Must not be greater than 2000 characters. Example: lwloauydlsmsjuryvojcy

reference_driver_units   integer  optional    

Must be at least 0. Must not be greater than 999999. Example: 2

is_active   boolean  optional    

Example: false

DELETE api/v1/admin/master-data/master-departments/{masterDepartment_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-departments/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/master-departments/{masterDepartment_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

masterDepartment_id   integer     

The ID of the masterDepartment. Example: 1

POST api/v1/admin/master-data/master-units

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"name_ar\": \"qxbajwbpilpmufinllwlo\",
    \"unit_type\": \"auydlsmsjuryvojcybzvr\",
    \"benchmark_unit_area_m2_min\": 11613.31890586,
    \"benchmark_unit_area_m2_max\": 11613.31890586,
    \"benchmark_unit_area_notes\": \"opfuudtdsufvyvddqamni\",
    \"benchmark_piece_area_m2_min\": 11613.31890586,
    \"benchmark_piece_area_m2_max\": 11613.31890586,
    \"benchmark_piece_basis\": \"opfuudtdsufvyvddqamni\",
    \"benchmark_piece_notes\": \"ihfqcoynlazghdtqtqxba\",
    \"legacy_benchmark_area\": \"jwbpilpmufinllwloauyd\",
    \"legacy_benchmark_basis\": \"lsmsjuryvojcybzvrbyic\",
    \"primary_owner\": \"kznkygloigmkwxphlvazj\",
    \"is_mandatory\": \"rcnfbaqywuxhgjjmzuxju\",
    \"clinical_or_non_clinical\": \"bqouzswiwxtrkimfcatbx\",
    \"is_active\": true,
    \"fav\": 0,
    \"workflow\": {
        \"code\": \"spzmrazsroyjpxmqesedy\",
        \"name_en\": \"ghenqcopwvownkbamlnfn\",
        \"name_ar\": \"gefbeilfzsyuxoezbdtab\",
        \"steps\": [
            {
                \"step_name_en\": \"niihfqcoynlazghdtqtqx\",
                \"step_name_ar\": \"bajwbpilpmufinllwloau\",
                \"step_type\": \"ydlsmsjuryvojcybzvrby\",
                \"is_required\": false,
                \"requires_master_department_id\": 17,
                \"requires_master_unit_id\": 17
            }
        ]
    },
    \"workflow_clear\": true,
    \"department_links\": [
        {
            \"master_department_id\": 17,
            \"importance\": \"mqeopfuudtdsufvyvddqa\",
            \"sort_order\": 45,
            \"is_active\": false
        }
    ]
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units"
);

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

let body = {
    "code": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "name_ar": "qxbajwbpilpmufinllwlo",
    "unit_type": "auydlsmsjuryvojcybzvr",
    "benchmark_unit_area_m2_min": 11613.31890586,
    "benchmark_unit_area_m2_max": 11613.31890586,
    "benchmark_unit_area_notes": "opfuudtdsufvyvddqamni",
    "benchmark_piece_area_m2_min": 11613.31890586,
    "benchmark_piece_area_m2_max": 11613.31890586,
    "benchmark_piece_basis": "opfuudtdsufvyvddqamni",
    "benchmark_piece_notes": "ihfqcoynlazghdtqtqxba",
    "legacy_benchmark_area": "jwbpilpmufinllwloauyd",
    "legacy_benchmark_basis": "lsmsjuryvojcybzvrbyic",
    "primary_owner": "kznkygloigmkwxphlvazj",
    "is_mandatory": "rcnfbaqywuxhgjjmzuxju",
    "clinical_or_non_clinical": "bqouzswiwxtrkimfcatbx",
    "is_active": true,
    "fav": 0,
    "workflow": {
        "code": "spzmrazsroyjpxmqesedy",
        "name_en": "ghenqcopwvownkbamlnfn",
        "name_ar": "gefbeilfzsyuxoezbdtab",
        "steps": [
            {
                "step_name_en": "niihfqcoynlazghdtqtqx",
                "step_name_ar": "bajwbpilpmufinllwloau",
                "step_type": "ydlsmsjuryvojcybzvrby",
                "is_required": false,
                "requires_master_department_id": 17,
                "requires_master_unit_id": 17
            }
        ]
    },
    "workflow_clear": true,
    "department_links": [
        {
            "master_department_id": 17,
            "importance": "mqeopfuudtdsufvyvddqa",
            "sort_order": 45,
            "is_active": false
        }
    ]
};

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

Request      

POST api/v1/admin/master-data/master-units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

code   string     

Must not be greater than 32 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

name_ar   string  optional    

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

unit_type   string     

Must not be greater than 64 characters. Example: auydlsmsjuryvojcybzvr

benchmark_unit_area_m2_min   number  optional    

Example: 11613.31890586

benchmark_unit_area_m2_max   number  optional    

Example: 11613.31890586

benchmark_unit_area_notes   string  optional    

Must not be greater than 191 characters. Example: opfuudtdsufvyvddqamni

benchmark_piece_area_m2_min   number  optional    

Example: 11613.31890586

benchmark_piece_area_m2_max   number  optional    

Example: 11613.31890586

benchmark_piece_basis   string  optional    

Must not be greater than 100 characters. Example: opfuudtdsufvyvddqamni

benchmark_piece_notes   string  optional    

Must not be greater than 191 characters. Example: ihfqcoynlazghdtqtqxba

legacy_benchmark_area   string  optional    

Must not be greater than 128 characters. Example: jwbpilpmufinllwloauyd

legacy_benchmark_basis   string  optional    

Must not be greater than 191 characters. Example: lsmsjuryvojcybzvrbyic

primary_owner   string  optional    

Must not be greater than 191 characters. Example: kznkygloigmkwxphlvazj

is_mandatory   string  optional    

Must not be greater than 32 characters. Example: rcnfbaqywuxhgjjmzuxju

clinical_or_non_clinical   string  optional    

Must not be greater than 48 characters. Example: bqouzswiwxtrkimfcatbx

is_active   boolean  optional    

Example: true

fav   integer  optional    

Example: 0

Must be one of:
  • 0
  • 1
department_links   object[]  optional    
master_department_id   integer     

The id of an existing record in the master_departments table. Example: 17

importance   string  optional    

Must not be greater than 32 characters. Example: mqeopfuudtdsufvyvddqa

sort_order   integer  optional    

Must be at least 0. Example: 45

is_active   boolean  optional    

Example: false

workflow   object  optional    
code   string  optional    

Must not be greater than 32 characters. Example: spzmrazsroyjpxmqesedy

name_en   string  optional    

Must not be greater than 255 characters. Example: ghenqcopwvownkbamlnfn

name_ar   string  optional    

Must not be greater than 255 characters. Example: gefbeilfzsyuxoezbdtab

steps   object[]  optional    
step_name_en   string     

Must not be greater than 255 characters. Example: niihfqcoynlazghdtqtqx

step_name_ar   string  optional    

Must not be greater than 255 characters. Example: bajwbpilpmufinllwloau

step_type   string  optional    

Must not be greater than 64 characters. Example: ydlsmsjuryvojcybzvrby

is_required   boolean  optional    

Example: false

requires_master_department_id   integer  optional    

The id of an existing record in the master_departments table. Example: 17

requires_master_unit_id   integer  optional    

The id of an existing record in the master_units table. Example: 17

workflow_clear   boolean  optional    

Example: true

PUT api/v1/admin/master-data/master-units/{master_unit_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"vmqeopfuudtdsufvyvddq\",
    \"name_en\": \"amniihfqcoynlazghdtqt\",
    \"name_ar\": \"qxbajwbpilpmufinllwlo\",
    \"unit_type\": \"auydlsmsjuryvojcybzvr\",
    \"benchmark_unit_area_m2_min\": 11613.31890586,
    \"benchmark_unit_area_m2_max\": 11613.31890586,
    \"benchmark_unit_area_notes\": \"opfuudtdsufvyvddqamni\",
    \"benchmark_piece_area_m2_min\": 11613.31890586,
    \"benchmark_piece_area_m2_max\": 11613.31890586,
    \"benchmark_piece_basis\": \"opfuudtdsufvyvddqamni\",
    \"benchmark_piece_notes\": \"ihfqcoynlazghdtqtqxba\",
    \"legacy_benchmark_area\": \"jwbpilpmufinllwloauyd\",
    \"legacy_benchmark_basis\": \"lsmsjuryvojcybzvrbyic\",
    \"primary_owner\": \"kznkygloigmkwxphlvazj\",
    \"is_mandatory\": \"rcnfbaqywuxhgjjmzuxju\",
    \"clinical_or_non_clinical\": \"bqouzswiwxtrkimfcatbx\",
    \"is_active\": true,
    \"fav\": 0,
    \"workflow\": {
        \"code\": \"spzmrazsroyjpxmqesedy\",
        \"name_en\": \"ghenqcopwvownkbamlnfn\",
        \"name_ar\": \"gefbeilfzsyuxoezbdtab\",
        \"steps\": [
            {
                \"step_name_en\": \"niihfqcoynlazghdtqtqx\",
                \"step_name_ar\": \"bajwbpilpmufinllwloau\",
                \"step_type\": \"ydlsmsjuryvojcybzvrby\",
                \"is_required\": false,
                \"requires_master_department_id\": 17,
                \"requires_master_unit_id\": 17
            }
        ]
    },
    \"workflow_clear\": true,
    \"department_links\": [
        {
            \"master_department_id\": 17,
            \"importance\": \"mqeopfuudtdsufvyvddqa\",
            \"sort_order\": 45,
            \"is_active\": false
        }
    ]
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units/1"
);

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

let body = {
    "code": "vmqeopfuudtdsufvyvddq",
    "name_en": "amniihfqcoynlazghdtqt",
    "name_ar": "qxbajwbpilpmufinllwlo",
    "unit_type": "auydlsmsjuryvojcybzvr",
    "benchmark_unit_area_m2_min": 11613.31890586,
    "benchmark_unit_area_m2_max": 11613.31890586,
    "benchmark_unit_area_notes": "opfuudtdsufvyvddqamni",
    "benchmark_piece_area_m2_min": 11613.31890586,
    "benchmark_piece_area_m2_max": 11613.31890586,
    "benchmark_piece_basis": "opfuudtdsufvyvddqamni",
    "benchmark_piece_notes": "ihfqcoynlazghdtqtqxba",
    "legacy_benchmark_area": "jwbpilpmufinllwloauyd",
    "legacy_benchmark_basis": "lsmsjuryvojcybzvrbyic",
    "primary_owner": "kznkygloigmkwxphlvazj",
    "is_mandatory": "rcnfbaqywuxhgjjmzuxju",
    "clinical_or_non_clinical": "bqouzswiwxtrkimfcatbx",
    "is_active": true,
    "fav": 0,
    "workflow": {
        "code": "spzmrazsroyjpxmqesedy",
        "name_en": "ghenqcopwvownkbamlnfn",
        "name_ar": "gefbeilfzsyuxoezbdtab",
        "steps": [
            {
                "step_name_en": "niihfqcoynlazghdtqtqx",
                "step_name_ar": "bajwbpilpmufinllwloau",
                "step_type": "ydlsmsjuryvojcybzvrby",
                "is_required": false,
                "requires_master_department_id": 17,
                "requires_master_unit_id": 17
            }
        ]
    },
    "workflow_clear": true,
    "department_links": [
        {
            "master_department_id": 17,
            "importance": "mqeopfuudtdsufvyvddqa",
            "sort_order": 45,
            "is_active": false
        }
    ]
};

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

Request      

PUT api/v1/admin/master-data/master-units/{master_unit_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

Body Parameters

code   string     

Must not be greater than 32 characters. Example: vmqeopfuudtdsufvyvddq

name_en   string     

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

name_ar   string  optional    

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

unit_type   string     

Must not be greater than 64 characters. Example: auydlsmsjuryvojcybzvr

benchmark_unit_area_m2_min   number  optional    

Example: 11613.31890586

benchmark_unit_area_m2_max   number  optional    

Example: 11613.31890586

benchmark_unit_area_notes   string  optional    

Must not be greater than 191 characters. Example: opfuudtdsufvyvddqamni

benchmark_piece_area_m2_min   number  optional    

Example: 11613.31890586

benchmark_piece_area_m2_max   number  optional    

Example: 11613.31890586

benchmark_piece_basis   string  optional    

Must not be greater than 100 characters. Example: opfuudtdsufvyvddqamni

benchmark_piece_notes   string  optional    

Must not be greater than 191 characters. Example: ihfqcoynlazghdtqtqxba

legacy_benchmark_area   string  optional    

Must not be greater than 128 characters. Example: jwbpilpmufinllwloauyd

legacy_benchmark_basis   string  optional    

Must not be greater than 191 characters. Example: lsmsjuryvojcybzvrbyic

primary_owner   string  optional    

Must not be greater than 191 characters. Example: kznkygloigmkwxphlvazj

is_mandatory   string  optional    

Must not be greater than 32 characters. Example: rcnfbaqywuxhgjjmzuxju

clinical_or_non_clinical   string  optional    

Must not be greater than 48 characters. Example: bqouzswiwxtrkimfcatbx

is_active   boolean  optional    

Example: true

fav   integer  optional    

Example: 0

Must be one of:
  • 0
  • 1
department_links   object[]  optional    
master_department_id   integer     

The id of an existing record in the master_departments table. Example: 17

importance   string  optional    

Must not be greater than 32 characters. Example: mqeopfuudtdsufvyvddqa

sort_order   integer  optional    

Must be at least 0. Example: 45

is_active   boolean  optional    

Example: false

workflow   object  optional    
code   string  optional    

Must not be greater than 32 characters. Example: spzmrazsroyjpxmqesedy

name_en   string  optional    

Must not be greater than 255 characters. Example: ghenqcopwvownkbamlnfn

name_ar   string  optional    

Must not be greater than 255 characters. Example: gefbeilfzsyuxoezbdtab

steps   object[]  optional    
step_name_en   string     

Must not be greater than 255 characters. Example: niihfqcoynlazghdtqtqx

step_name_ar   string  optional    

Must not be greater than 255 characters. Example: bajwbpilpmufinllwloau

step_type   string  optional    

Must not be greater than 64 characters. Example: ydlsmsjuryvojcybzvrby

is_required   boolean  optional    

Example: false

requires_master_department_id   integer  optional    

The id of an existing record in the master_departments table. Example: 17

requires_master_unit_id   integer  optional    

The id of an existing record in the master_units table. Example: 17

workflow_clear   boolean  optional    

Example: true

DELETE api/v1/admin/master-data/master-units/{master_unit_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/master-units/1"
);

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


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

Request      

DELETE api/v1/admin/master-data/master-units/{master_unit_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_unit_id   integer     

The ID of the master unit. Example: 1

Master Medical Devices

List medical devices with optional filters and sorting.

Query: search (name/code), device_type, is_active (0|1), sort (name|code|device_type|is_active|created_at|updated_at), direction (asc|desc), per_page (max 100).

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices"
);

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


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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 89
access-control-allow-origin: *
 

{
    "message": "Unauthenticated"
}
 

Request      

GET api/v1/admin/master-data/medical-devices

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/admin/master-data/medical-devices

Example request:
curl --request POST \
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"code\": \"amniihfqcoynlazghdtqt\",
    \"description\": \"Necessitatibus architecto aut consequatur debitis et id.\",
    \"device_type\": \"ilpmufinllwloauydlsms\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "code": "amniihfqcoynlazghdtqt",
    "description": "Necessitatibus architecto aut consequatur debitis et id.",
    "device_type": "ilpmufinllwloauydlsms",
    "is_active": true
};

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

Request      

POST api/v1/admin/master-data/medical-devices

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

code   string     

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 64 characters. Example: amniihfqcoynlazghdtqt

description   string  optional    

Must not be greater than 5000 characters. Example: Necessitatibus architecto aut consequatur debitis et id.

device_type   string  optional    

Must not be greater than 128 characters. Example: ilpmufinllwloauydlsms

is_active   boolean  optional    

Example: true

GET api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Example request:
curl --request GET \
    --get "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur"
);

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


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

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 88
access-control-allow-origin: *
 

{
    "message": "No query results for model [App\\Models\\MasterMedicalDevice] consequatur"
}
 

Request      

GET api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_medical_device_id   string     

The ID of the master medical device. Example: consequatur

PUT api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Example request:
curl --request PUT \
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"code\": \"amniihfqcoynlazghdtqt\",
    \"description\": \"Necessitatibus architecto aut consequatur debitis et id.\",
    \"device_type\": \"ilpmufinllwloauydlsms\",
    \"is_active\": true
}"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "code": "amniihfqcoynlazghdtqt",
    "description": "Necessitatibus architecto aut consequatur debitis et id.",
    "device_type": "ilpmufinllwloauydlsms",
    "is_active": true
};

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

Request      

PUT api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_medical_device_id   string     

The ID of the master medical device. Example: consequatur

Body Parameters

name   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

code   string  optional    

Must match the regex /^[A-Za-z0-9-_]+$/. Must not be greater than 64 characters. Example: amniihfqcoynlazghdtqt

description   string  optional    

Must not be greater than 5000 characters. Example: Necessitatibus architecto aut consequatur debitis et id.

device_type   string  optional    

Must not be greater than 128 characters. Example: ilpmufinllwloauydlsms

is_active   boolean  optional    

Example: true

DELETE api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Example request:
curl --request DELETE \
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://127.0.0.1:8800/api/v1/admin/master-data/medical-devices/consequatur"
);

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


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

Request      

DELETE api/v1/admin/master-data/medical-devices/{master_medical_device_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

master_medical_device_id   string     

The ID of the master medical device. Example: consequatur