Introduction

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

Base URL

http://rapidserv.local:8000

Authenticating requests

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

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

You can retrieve your token by visiting your dashboard and clicking Generate API token.

2Fa Management

Enable two factor authentication for the user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/2fa-enable"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/2fa-enable" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Disable two factor authentication for the user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/2fa-disable"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/2fa-disable" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get the two factor authentication recovery codes for authenticated user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/get-recovery-code"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/get-recovery-code" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Generate a fresh set of two factor authentication recovery codes.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/gen-recovery-code"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/gen-recovery-code" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get the SVG element for the user's two factor authentication QR code.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/2fa-qr"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/2fa-qr" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Access Management

Apis for the Access

Initiate passwordless login

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/init-passwordless"
);

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

let body = {
    "unmn": "earum"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/init-passwordless" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unmn\": \"earum\"
}"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 598
vary: Origin


{
    "message": "The given data was invalid.",
    "errors": {
        "unmn": [
            "The selected user name is invalid."
        ]
    }
}

Received response:

Request failed with error:

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/login-passwordless"
);

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

let body = {
    "access": "distinctio",
    "password": "rerum"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/login-passwordless" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"access\": \"distinctio\",
    \"password\": \"rerum\"
}"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 597
vary: Origin


{
    "message": "The given data was invalid.",
    "errors": {
        "password": [
            "The account password must be at least 8 characters.",
            "The account password confirmation does not match."
        ]
    }
}

Received response:

Request failed with error:

Base price

Apis for managing base prices for the organisation or team

Display all the prices for this user.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/base-price"
);

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

let body = {
    "usage": "adipisci",
    "state": "active",
    "input_type": "quo"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/base-price" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"usage\": \"adipisci\",
    \"state\": \"active\",
    \"input_type\": \"quo\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified pricing item.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/base-price/2"
);

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

let body = {
    "price_per_unit": 20.1961,
    "handling": 486283.057038,
    "mark_up": 4547.143989537,
    "price": 49931.000599273,
    "transport": 50251065,
    "state": "est"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/base-price/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"price_per_unit\": 20.1961,
    \"handling\": 486283.057038,
    \"mark_up\": 4547.143989537,
    \"price\": 49931.000599273,
    \"transport\": 50251065,
    \"state\": \"est\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/base-price/{id}

PATCH api/base-price/{id}

URL Parameters

id integer

The ID of the base price.

base_price integer optional

The base price id

Body Parameters

price_per_unit number optional

handling number optional

mark_up number optional

price number optional

transport number optional

state string optional

Bid management

Display the specified bid.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bids/sunt"
);

const params = {
    "bid": "2",
    "project": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bids/sunt?bid=2&project=19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Submit the bid to be considered for evaluations.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/cost/1/bid"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/cost/1/bid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all the bids of the project Filter the bids further by using the url parameters to specify status

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bids"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bids?filter=comfirmed%2Cawarded" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all the bids of the project Filter the bids further by using the url parameters to specify status

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bid"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bid?filter=comfirmed%2Cawarded" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all the bids relevant to the organisation

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bids"
);

const params = {
    "items": "4",
    "contract": "0",
    "boq": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "items": 13,
    "contract": "ut",
    "boq": 12
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bids?items=4&contract=&boq=7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 13,
    \"contract\": \"ut\",
    \"boq\": 12
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/bids

Query Parameters

items integer optional

This is how many results are returned

contract boolean optional

This specifies if the requested bids should have been comfirmed as accepted contracts only

boq integer optional

This specifies if the requested bids should be related to the boq id specified

Body Parameters

items integer optional

order string optional

sort string optional

contract string optional

boq integer optional

Set status of a bid. status as follows 0:create, 1:received, 2:submitted, 3:negotiating, 4:closed, 5:approved, 6:award 7:accept 8:decline 9:internal

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bid-status/1"
);

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

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

let body = {
    "status": 19
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/bid-status/1?status=6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": 19
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Submit the ids of bids to compare

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bids/compare"
);

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

let body = {
    "bid": [
        5
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/bids/compare" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bid\": [
        5
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Submit the ids of estimates to compare

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/estimate/compare"
);

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

let body = {
    "estimate": [
        10
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/estimate/compare" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"estimate\": [
        10
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Bill description management

Apis for managing bill descriptions for a user

Display a listing of the billing descriptions.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-desc"
);

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

let body = {
    "items": 3,
    "element": 2,
    "project_list_id": 9
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bill-desc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 3,
    \"element\": 2,
    \"project_list_id\": 9
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly bill description in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-desc"
);

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

let body = {
    "desr": "repellat",
    "unit_id": 8,
    "team": [
        20
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/bill-desc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"repellat\",
    \"unit_id\": 8,
    \"team\": [
        20
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the bill description.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-desc/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bill-desc/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the bill description in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-desc/1"
);

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

let body = {
    "desr": "hic",
    "unit_id": 2,
    "team": [
        20
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/bill-desc/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"hic\",
    \"unit_id\": 2,
    \"team\": [
        20
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/bill-desc/{id}

PATCH api/bill-desc/{id}

URL Parameters

id integer

The ID of the bill desc.

bill_desc integer

This is the bill description ID

Body Parameters

desr string

This is the take off descriptiom

unit_id integer

This is the unit ID

team integer[] optional

This is array for the team this bill will be used

Remove the bill description from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-desc/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/bill-desc/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Bill of Quantity management

Finalize the bill and take off.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bill/quis/finalize"
);

const params = {
    "project": "13",
    "bill": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bill/quis/finalize?project=13&bill=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/project/{project_id}/bill/{bill}/finalize

URL Parameters

project_id integer

The ID of the project.

bill string

The bill.

Query Parameters

project integer optional

This is the id of the project.

bill integer optional

This is the id of the boq sheet.

Update the preliminary for this bill.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill/1/update-preliminary"
);

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

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

let body = {
    "preliminaries": [
        "sit"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/bill/1/update-preliminary?bill=11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"preliminaries\": [
        \"sit\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the rogue-item for this bill.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill/1/rogue-item"
);

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

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

let body = {
    "rogue_items": [
        "qui"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/bill/1/rogue-item?bill=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rogue_items\": [
        \"qui\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Upload bill of quantities into Rapisurv

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-upload"
);

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

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/bill-upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "desr=officiis" \
    --form "document=@C:\Users\crevi\AppData\Local\Temp\phpB2B4.tmp"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Upload bill of quantities into Rapisurv

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill-upload-legacy"
);

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

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/bill-upload-legacy" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "data=velit" \
    --form "project_list_id=5" \
    --form "document=@C:\Users\crevi\AppData\Local\Temp\phpB2C6.tmp"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display bills for a given project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bill"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bill" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bill/excepturi"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/bill/excepturi?bill=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bill/ut"
);

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

let body = {
    "data": [],
    "locked": true
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/705/bill/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [],
    \"locked\": true
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{project_id}/bill/{id}

PATCH api/project/{project_id}/bill/{id}

URL Parameters

project_id integer

The ID of the project.

id string

The ID of the bill.

Body Parameters

data object optional

This is the data of takeoff sheet.

locked boolean

Remove the specified resource from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/bill/voluptate"
);

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

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/705/bill/voluptate?bill=16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

All bills for this organisation

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bills"
);

const params = {
    "items": "18",
    "shared": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "items": 13,
    "search": "sed"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bills?items=18&shared=" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 13,
    \"search\": \"sed\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/bills

Query Parameters

items integer optional

This is how many results are returned

shared boolean optional

Filter if the boqs returned where shared or not

Body Parameters

items integer optional

shared string optional

order string optional

sort string optional

search string optional

Display the rogue items of a bill.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill/1/rogue-item"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bill/1/rogue-item" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the bill resource.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/bill/1"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/bill/1?bill=11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/share-boq"
);

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

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

let body = {
    "unmn": "in",
    "data": [
        "ad"
    ],
    "preliminaries": [
        "sed"
    ],
    "rogue_items": [
        "suscipit"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/705/share-boq?project=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unmn\": \"in\",
    \"data\": [
        \"ad\"
    ],
    \"preliminaries\": [
        \"sed\"
    ],
    \"rogue_items\": [
        \"suscipit\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Cost management

Display a listing of the resource.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/cost"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/cost" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Create a new cost version for this finalised bill project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/cost"
);

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

let body = {
    "locked": true,
    "data": "ratione",
    "name": "dignissimos"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/705/cost" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"locked\": true,
    \"data\": \"ratione\",
    \"name\": \"dignissimos\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/project/{project_id}/cost

URL Parameters

project_id integer

The ID of the project.

project string

integer This is the project id

Body Parameters

locked boolean

data string

name string optional

bid_id string optional

Display the costing.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/cost/qui"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/cost/qui?body=omnis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the costing in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/cost/quos"
);

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

let body = {
    "data": [],
    "default": true,
    "locked": false
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/705/cost/quos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [],
    \"default\": true,
    \"locked\": false
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{project_id}/cost/{id}

PATCH api/project/{project_id}/cost/{id}

URL Parameters

project_id integer

The ID of the project.

id string

The ID of the cost.

Body Parameters

data object

This s the data

default boolean

locked boolean

name string optional

Remove the costing from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/cost/ut"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/705/cost/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

All costs for this organisation

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/costs"
);

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

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

let body = {
    "items": 19,
    "search": "laboriosam"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/costs?items=4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 19,
    \"search\": \"laboriosam\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/costs

Query Parameters

items integer optional

This is how many results are returned

Body Parameters

items integer optional

shared string optional

order string optional

sort string optional

search string optional

GET api/variants

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/variants"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/variants" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Price module

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/price/ea/numquam"
);

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

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

let body = {
    "default": true
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/price/ea/numquam?default=assumenda" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"default\": true
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/price/{bill_code}/{type?}

URL Parameters

bill_code string

type string optional

Query Parameters

default string optional

This is either true or flase but not mandatory

Body Parameters

default boolean optional

Get prices from a number of specified bill descriptions

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/prices/veniam"
);

const params = {
    "bill_codes": "in",
    "default": "voluptatibus",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "default": false,
    "bill_codes": "aliquid"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/prices/veniam?bill_codes=in&default=voluptatibus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"default\": false,
    \"bill_codes\": \"aliquid\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/prices/{type?}

URL Parameters

type string optional

Query Parameters

bill_codes string

This is used as bill_codes=bf-065,bf-0066

default string optional

This is either true or flase but not mandatory

Body Parameters

default boolean optional

bill_codes string

Refresh the prices of a user

requires authentication

This only affects the original prices which where imported at first

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/base-price/refresh"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/base-price/refresh" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

POST api/base-price/create

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/base-price/create"
);

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

let body = {
    "input_name": "itaque",
    "input_type": "distinctio",
    "price": 50174822.6,
    "transport": 122814078.19,
    "handling": 351824171.7114,
    "mark_up": 266.0551,
    "price_per_unit": 4569,
    "conversion_factor": 26469.6,
    "apply": false,
    "usage": "incidunt",
    "delivery_unit": 57986586.4
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/base-price/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"input_name\": \"itaque\",
    \"input_type\": \"distinctio\",
    \"price\": 50174822.6,
    \"transport\": 122814078.19,
    \"handling\": 351824171.7114,
    \"mark_up\": 266.0551,
    \"price_per_unit\": 4569,
    \"conversion_factor\": 26469.6,
    \"apply\": false,
    \"usage\": \"incidunt\",
    \"delivery_unit\": 57986586.4
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/base-price/create

Body Parameters

input_name string

input_type string

price number

transport number optional

handling number optional

mark_up number optional

price_per_unit number optional

conversion_operator string optional

'delivery_unit' => (int) $basePrice delivery_unit,.

conversion_factor number optional

apply boolean optional

usage string optional

delivery_unit number optional

variation_id string optional

unit_id string optional

bill_desc_id string optional

qty_consumption_unit string optional

This field is required when bill_desc_id is present.

Get materials from cost

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/nihil/materials/ut"
);

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

let body = {
    "project": "nam",
    "cost": "quae"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/nihil/materials/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project\": \"nam\",
    \"cost\": \"quae\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/project/{project}/materials/{cost?}

URL Parameters

project string

The project.

cost string optional

Body Parameters

project this optional

is the project id where the material are supposed to be picked

cost This optional

is the cost where the actual materials are supposed to picked. Its not mandatory

Demand Management

Display a listing of the demands.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/demands"
);

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

let body = {
    "items": 12,
    "search": "est",
    "status": [
        "qui"
    ],
    "type": [
        "enim"
    ]
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/demands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 12,
    \"search\": \"est\",
    \"status\": [
        \"qui\"
    ],
    \"type\": [
        \"enim\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created demands in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/demands"
);

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

let body = {
    "project_list_id": "placeat"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/demands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_list_id\": \"placeat\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified demands.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/demands/9"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/demands/9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified demands in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/demands/9"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/demands/9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified demands from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/demands/9"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/demands/9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Department managment

Display a listing of the department.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/departments"
);

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

let body = {
    "items": 18,
    "search": "dignissimos"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 18,
    \"search\": \"dignissimos\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created department in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/departments"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified department.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/departments/4"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/departments/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified department in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/departments/4"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/departments/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified department from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/departments/4"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/departments/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Endpoints

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/get-descriptions

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/get-descriptions"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/get-descriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 588
vary: Origin


{
    "message": "Attempt to read property \"import_data\" on null",
    "exception": "ErrorException",
    "file": "D:\\projects\\rapiserv\\app\\Http\\Controllers\\MasterFormatImport.php",
    "line": 182,
    "trace": [
        {
            "file": "D:\\projects\\rapiserv\\app\\Http\\Controllers\\MasterFormatImport.php",
            "line": 182,
            "function": "handleError",
            "class": "Illuminate\\Foundation\\Bootstrap\\HandleExceptions",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Controller.php",
            "line": 54,
            "function": "getElemDeTst",
            "class": "App\\Http\\Controllers\\MasterFormatImport",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ControllerDispatcher.php",
            "line": 45,
            "function": "callAction",
            "class": "Illuminate\\Routing\\Controller",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 262,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 205,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 721,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 127,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 103,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 55,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\sanctum\\src\\Http\\Middleware\\EnsureFrontendRequestsAreStateful.php",
            "line": 33,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\sanctum\\src\\Http\\Middleware\\EnsureFrontendRequestsAreStateful.php",
            "line": 34,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\app\\Http\\Middleware\\EnforceApiStandard.php",
            "line": 29,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "App\\Http\\Middleware\\EnforceApiStandard",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 723,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 698,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 662,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 651,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 167,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\livewire\\livewire\\src\\DisableBrowserCache.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Livewire\\DisableBrowserCache",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fruitcake\\laravel-cors\\src\\HandleCors.php",
            "line": 52,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fideloper\\proxy\\src\\TrustProxies.php",
            "line": 57,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fideloper\\Proxy\\TrustProxies",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 142,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 111,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 179,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Commands\\GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Util.php",
            "line": 40,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 37,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 653,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 136,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Command\\Command.php",
            "line": 298,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 121,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 1040,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 301,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 171,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Application.php",
            "line": 94,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Console\\Kernel.php",
            "line": 129,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\artisan",
            "line": 37,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}

Received response:

Request failed with error:

POST api/pabbly-create-user

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/pabbly-create-user"
);

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

let body = {
    "finm": "qg",
    "lamn": "nvzjvnq",
    "orgn": "gwqktxubhwayjgaxquffueybvvmyomziqpflbpnfcxull",
    "email": "cklz",
    "zone": 7917181,
    "address": {
        "adds": "gosafdnqsoeetpwntcleuyv",
        "city": "blpsbfnhdhuoefqgcgtrkrp",
        "poco": "aneilwm",
        "cotr": "rc",
        "cotn": "iqmwgmyidviyokno"
    }
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/pabbly-create-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"finm\": \"qg\",
    \"lamn\": \"nvzjvnq\",
    \"orgn\": \"gwqktxubhwayjgaxquffueybvvmyomziqpflbpnfcxull\",
    \"email\": \"cklz\",
    \"zone\": 7917181,
    \"address\": {
        \"adds\": \"gosafdnqsoeetpwntcleuyv\",
        \"city\": \"blpsbfnhdhuoefqgcgtrkrp\",
        \"poco\": \"aneilwm\",
        \"cotr\": \"rc\",
        \"cotn\": \"iqmwgmyidviyokno\"
    }
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/pabbly-create-user

Body Parameters

finm string

Must not be greater than 16 characters.

lamn string

Must not be greater than 16 characters.

orgn string optional

Must not be greater than 255 characters.

email string

Must be a valid email Must not be greater than 40 characters.

zone number

address object optional

address.adds string optional

Must not be greater than 60 characters.

address.city string optional

Must not be greater than 30 characters.

address.poco string optional

Must not be greater than 7 characters.

address.cotr string

Must be 2 characters.

address.cotn string optional

Must not be greater than 40 characters.

GET api/web-access

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/web-access"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/web-access" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-days"
);

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

let body = {
    "start_date": "2024-04-22",
    "end_date": "2105-04-04",
    "only": [
        "exercitationem"
    ]
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/work-days" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2024-04-22\",
    \"end_date\": \"2105-04-04\",
    \"only\": [
        \"exercitationem\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-days/2"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/work-days/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-days/2"
);

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

let body = {
    "work_day": [
        null
    ],
    "holiday": [
        {
            "date": "2024-04-22",
            "name": "impedit",
            "re_occur": "1"
        }
    ],
    "work_conversion": [
        {
            "day": 3212.1,
            "hour": 610394388.53283
        }
    ],
    "range": [
        {
            "unit": "month",
            "value": 1.465090195
        }
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/work-days/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"work_day\": [
        null
    ],
    \"holiday\": [
        {
            \"date\": \"2024-04-22\",
            \"name\": \"impedit\",
            \"re_occur\": \"1\"
        }
    ],
    \"work_conversion\": [
        {
            \"day\": 3212.1,
            \"hour\": 610394388.53283
        }
    ],
    \"range\": [
        {
            \"unit\": \"month\",
            \"value\": 1.465090195
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/work-days/{id}

PATCH api/work-days/{id}

URL Parameters

id integer

The ID of the work day.

Body Parameters

start_day string optional

work_day string[] optional

holiday object[] optional

holiday[].date string optional

Must be a valid date in the format Y-m-d.

holiday[].name string optional

holiday[].re_occur string optional

Must be one of 0 or 1.

work_conversion object[] optional

work_conversion[].day number

work_conversion[].hour number

range object[] optional

range[].unit string

Must be one of year, month, day, or week.

range[].value number

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/cost-plans"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/cost-plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/cost-plans"
);

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

let body = {
    "version": "4p1taw6"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/plans/1/cost-plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": \"4p1taw6\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/cost-plans/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/cost-plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/cost-plans/1"
);

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

let body = {
    "default": false
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/plans/1/cost-plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"default\": false
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/cost-plans/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/plans/1/cost-plans/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/forecasts"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/forecasts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/forecasts"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/plans/1/forecasts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/forecasts/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/forecasts/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/forecasts/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/plans/1/forecasts/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/forecasts/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/plans/1/forecasts/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/budgets"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/budgets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/budgets"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/plans/1/budgets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/budgets/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/plans/1/budgets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/budgets/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/plans/1/budgets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/plans/1/budgets/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/plans/1/budgets/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/work-day/refresh

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-day/refresh"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/work-day/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all the collaborations for the user.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration"
);

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

let body = {
    "items": 11,
    "type": "project",
    "filter": "incoming"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/collaboration" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 11,
    \"type\": \"project\",
    \"filter\": \"incoming\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration/4"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/collaboration/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration/4"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/collaboration/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration/4"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/collaboration/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the user from the collaboration

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration/4/remove-user"
);

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

let body = {
    "email": "augustine.mraz@example.com"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/collaboration/4/remove-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"augustine.mraz@example.com\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Add the user to the collaboration

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/collaboration/4/add-user"
);

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

let body = {
    "email": "roberta.romaguera@example.net",
    "permission": [
        "eum"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/collaboration/4/add-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"roberta.romaguera@example.net\",
    \"permission\": [
        \"eum\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/variation"
);

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

let body = {
    "project_id": 11,
    "date": "2024-04-22",
    "items": 18
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/variation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 11,
    \"date\": \"2024-04-22\",
    \"items\": 18
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Create a variation.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/variation"
);

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

let body = {
    "cost_id": 2,
    "bill_desc": [
        19
    ],
    "variation": "est"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/variation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cost_id\": 2,
    \"bill_desc\": [
        19
    ],
    \"variation\": \"est\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display specified variation.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/variation/3"
);

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

let body = {
    "certificate_id": "et",
    "variation_date": "velit",
    "valuation_date": "2024-04-22"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/variation/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"certificate_id\": \"et\",
    \"variation_date\": \"velit\",
    \"valuation_date\": \"2024-04-22\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/variation/3"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/variation/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all collaborators on the project

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/voluptas/collaborators"
);

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

let body = {
    "items": 8
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/voluptas/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 8
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects"
);

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

let body = {
    "desr": "pariatur",
    "location": "occaecati",
    "storage_location": 18,
    "folder_name": [
        "quia"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/projects" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"pariatur\",
    \"location\": \"occaecati\",
    \"storage_location\": 18,
    \"folder_name\": [
        \"quia\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects"
);

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

let body = {
    "items": 13,
    "search": "illum",
    "recent": "projects",
    "filter": "no_take_off",
    "storage_location_id": 17
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/projects" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 13,
    \"search\": \"illum\",
    \"recent\": \"projects\",
    \"filter\": \"no_take_off\",
    \"storage_location_id\": 17
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/projects

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

recent string optional

Must be one of bills, projects, take-offs, cost, finalized, or shared.

plans string optional

filter string optional

Must be one of no_take_off, no_bill, or no_bid.

take_off string optional

bill string optional

bid string optional

estimate string optional

storage_location_id integer optional

legacy string optional

work-plan string optional

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/suscipit"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/projects/suscipit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/master-elements

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/master-elements"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/master-elements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

content-type: text/html; charset=UTF-8
cache-control: no-cache, private
x-ratelimit-limit: 600
x-ratelimit-remaining: 591
vary: Origin

Received response:

Request failed with error:

GET api/custom-descriptions

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/custom-descriptions"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/custom-descriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 590
vary: Origin


{
    "message": "The given data was invalid.",
    "errors": {
        "4445": [
            "The Item has not be created"
        ]
    }
}

Received response:

Request failed with error:

DELETE api/master-elements

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/master-elements"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/master-elements" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 589
vary: Origin


{
    "status": 200,
    "success": true,
    "data": []
}

Received response:

Request failed with error:

POST api/prepare-data

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/prepare-data"
);

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

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/prepare-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quis\"
}"

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 587
vary: Origin


{
    "message": "File not found at path: other/quis.json",
    "exception": "Illuminate\\Contracts\\Filesystem\\FileNotFoundException",
    "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Filesystem\\FilesystemAdapter.php",
    "line": 171,
    "trace": [
        {
            "file": "D:\\projects\\rapiserv\\app\\Http\\Controllers\\MasterFormatImport.php",
            "line": 307,
            "function": "get",
            "class": "Illuminate\\Filesystem\\FilesystemAdapter",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Controller.php",
            "line": 54,
            "function": "prepareData",
            "class": "App\\Http\\Controllers\\MasterFormatImport",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ControllerDispatcher.php",
            "line": 45,
            "function": "callAction",
            "class": "Illuminate\\Routing\\Controller",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 262,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 205,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 721,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 127,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 103,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 55,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\sanctum\\src\\Http\\Middleware\\EnsureFrontendRequestsAreStateful.php",
            "line": 33,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\sanctum\\src\\Http\\Middleware\\EnsureFrontendRequestsAreStateful.php",
            "line": 34,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\app\\Http\\Middleware\\EnforceApiStandard.php",
            "line": 29,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "App\\Http\\Middleware\\EnforceApiStandard",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 723,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 698,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 662,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 651,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 167,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\livewire\\livewire\\src\\DisableBrowserCache.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Livewire\\DisableBrowserCache",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fruitcake\\laravel-cors\\src\\HandleCors.php",
            "line": 52,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fideloper\\proxy\\src\\TrustProxies.php",
            "line": 57,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fideloper\\Proxy\\TrustProxies",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 142,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 111,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 179,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Commands\\GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Util.php",
            "line": 40,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 37,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 653,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 136,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Command\\Command.php",
            "line": 298,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 121,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 1040,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 301,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 171,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Application.php",
            "line": 94,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Console\\Kernel.php",
            "line": 129,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\artisan",
            "line": 37,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}

Received response:

Request failed with error:

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/groups"
);

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

let body = {
    "items": 14,
    "search": "laboriosam",
    "location": "et",
    "status": [
        "quo"
    ]
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 14,
    \"search\": \"laboriosam\",
    \"location\": \"et\",
    \"status\": [
        \"quo\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/groups"
);

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

let body = {
    "location": "et",
    "name": "tempore",
    "customer": [
        ""
    ],
    "bids": [
        12
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location\": \"et\",
    \"name\": \"tempore\",
    \"customer\": [
        \"\"
    ],
    \"bids\": [
        12
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/groups/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/groups/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/groups/1"
);

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

let body = {
    "location": "aspernatur",
    "name": "consectetur",
    "customer": [
        ""
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/groups/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"location\": \"aspernatur\",
    \"name\": \"consectetur\",
    \"customer\": [
        \"\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/groups/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/groups/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/projects/{project}/risks

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/molestias/risks"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/projects/molestias/risks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

File management system

File managment APIs

Display all the folders a user has access to.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders"
);

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

let body = {
    "items": 10,
    "search": "est",
    "project_list_id": 11
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/folders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 10,
    \"search\": \"est\",
    \"project_list_id\": 11
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/folders

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

project_list_id integer optional

root string optional

project_folder string optional

Store a newly created directory in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders"
);

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

let body = {
    "project_list_id": 10,
    "folder_id": 20,
    "folder_name": [
        "placeat"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/folders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_list_id\": 10,
    \"folder_id\": 20,
    \"folder_name\": [
        \"placeat\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the folder resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/folders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified directory from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1"
);

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

let body = {
    "folder_id": [
        2
    ]
};

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/folders/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder_id\": [
        2
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Add file to directory

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1/files"
);

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());

curl --request POST \
    "http://rapidserv.local:8000/api/folders/1/files" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file[]=@C:\Users\crevi\AppData\Local\Temp\phpA554.tmp"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get directory files

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1/files"
);

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

let body = {
    "items": 20,
    "search": "nostrum"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/folders/1/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 20,
    \"search\": \"nostrum\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Download file for view

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/files/doloremque"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/files/doloremque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all files in all folders of the user

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/files"
);

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

let body = {
    "items": 14,
    "search": "itaque"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 14,
    \"search\": \"itaque\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created work-flow storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1/work-flow"
);

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

let body = {
    "steps": [
        "quia"
    ],
    "allocation": [
        null
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/folders/1/work-flow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"steps\": [
        \"quia\"
    ],
    \"allocation\": [
        null
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified work-flow from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1/work-flow"
);

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

let body = {
    "force": true
};

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/folders/1/work-flow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"force\": true
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified work-flow storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/folders/1/work-flow"
);

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

let body = {
    "steps": [
        "sit"
    ],
    "allocation": [
        null
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/folders/1/work-flow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"steps\": [
        \"sit\"
    ],
    \"allocation\": [
        null
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

PUT api/files

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/files"
);

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

let body = {
    "file_id": [
        20
    ],
    "state": "deleniti"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file_id\": [
        20
    ],
    \"state\": \"deleniti\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Goods Issue

Apis for goods issue

Display a listing of the goods.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/goods"
);

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

let body = {
    "items": 11,
    "search": "ea",
    "txn_type": "tcsujpzycdvjaznmejxurckscyyjioxsrxmevucrrbdeanrmcpwhyuuhwidfgzjabgonsrbrfpbepwilckfosejqeixpxsnhzlfewfzyxbjbqhsmjdpyhvmnpaexxnsuavokunbjkwf",
    "storage_location_id": 7
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/goods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 11,
    \"search\": \"ea\",
    \"txn_type\": \"tcsujpzycdvjaznmejxurckscyyjioxsrxmevucrrbdeanrmcpwhyuuhwidfgzjabgonsrbrfpbepwilckfosejqeixpxsnhzlfewfzyxbjbqhsmjdpyhvmnpaexxnsuavokunbjkwf\",
    \"storage_location_id\": 7
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/goods

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

txn_type string optional

Must not be greater than 255 characters.

purchase_id string optional

storage_location_id integer optional

Store a newly created goods in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/goods"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/goods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified goods.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/goods/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/goods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified goods in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/goods/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/goods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified goods from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/goods/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/goods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a summary of the goods.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-summary"
);

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

let body = {
    "material_id": 12,
    "txn_type": "umoavjmwxpenkqddxrovirednye"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/good-summary" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"material_id\": 12,
    \"txn_type\": \"umoavjmwxpenkqddxrovirednye\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/good-summary

Body Parameters

order string optional

sort string optional

material_id integer optional

txn_type string optional

Must be one of receipt or issue Must not be greater than 255 characters.

purchase_id string optional

storage_location_id string optional

Inventory Report

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/inventory-report"
);

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

let body = {
    "items": 15,
    "material_id": 9,
    "material": "totam",
    "storage_location_id": 14,
    "search": "modi"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/inventory-report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 15,
    \"material_id\": 9,
    \"material\": \"totam\",
    \"storage_location_id\": 14,
    \"search\": \"modi\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/inventory-report

Body Parameters

items integer optional

order string optional

sort string optional

material_id integer optional

material string optional

storage_location_id integer optional

search string optional

Inventory Material Report

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/inventory-report/autem"
);

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

let body = {
    "items": 9,
    "storage_location_id": 13
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/inventory-report/autem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 9,
    \"storage_location_id\": 13
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Delivery tracking Report

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/delivery-report"
);

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

let body = {
    "items": 15,
    "search": "quasi"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/delivery-report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 15,
    \"search\": \"quasi\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Goods Items

Apis for goods items

Display a listing of the goods item.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-items"
);

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

let body = {
    "items": 5,
    "search": "cum",
    "good_id": 9
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/good-items" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 5,
    \"search\": \"cum\",
    \"good_id\": 9
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created goods item in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-items"
);

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

let body = {
    "good_id": "est",
    "material": "suscipit",
    "location": "pivphdarhnousmusgoqgbcwjorjvsvqaanrlpczgvpwmtzmmxykbibacwnvluakpczhgeenwttmmitliekystbiyjovduefilmagmkqmmigozpskmrutjjcccxcjafgrudmobctmthmtrdfahowqjojzwipnifhwnzeygeuovzenrsflpuenwdbfxtgkllutoqr"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/good-items" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"good_id\": \"est\",
    \"material\": \"suscipit\",
    \"location\": \"pivphdarhnousmusgoqgbcwjorjvsvqaanrlpczgvpwmtzmmxykbibacwnvluakpczhgeenwttmmitliekystbiyjovduefilmagmkqmmigozpskmrutjjcccxcjafgrudmobctmthmtrdfahowqjojzwipnifhwnzeygeuovzenrsflpuenwdbfxtgkllutoqr\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified goods item.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-items/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/good-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified goods item in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-items/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/good-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified goods item from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/good-items/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/good-items/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Helper

Show a list of the supported zones

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/zones"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/zones" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 595
vary: Origin


{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 1,
            "Country": "NG",
            "Country Name": "Nigeria - NIQS format - English",
            "Primary language": "ENG",
            "Secondary language": "English",
            "Country currency": "NGN"
        },
        {
            "id": 2,
            "Country": "UG",
            "Country Name": "Uganda",
            "Primary language": "ENG",
            "Secondary language": "English",
            "Country currency": "UGX"
        },
        {
            "id": 3,
            "Country": "US",
            "Country Name": "United States of America",
            "Primary language": "ENG",
            "Secondary language": "English",
            "Country currency": "$"
        },
        {
            "id": 5,
            "Country": "TZ",
            "Country Name": "Tanzania",
            "Primary language": "ENG",
            "Secondary language": "English",
            "Country currency": "TZS"
        },
        {
            "id": 6,
            "Country": "US",
            "Country Name": "United State of America",
            "Primary language": "EN",
            "Secondary language": "English",
            "Country currency": "USD"
        },
        {
            "id": 7,
            "Country": "CA",
            "Country Name": "Canada - CSI MasterFormat 2020",
            "Primary language": "EN",
            "Secondary language": "English",
            "Country currency": "CAD"
        }
    ],
    "pagination": {
        "count": 6,
        "total": 6,
        "perPage": 15,
        "currentPage": 1,
        "totalPages": 1,
        "links": []
    }
}

Received response:

Request failed with error:

Show a list of the supported countries

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/country"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/country" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 594
vary: Origin


{
    "status": 200,
    "success": true,
    "data": [
        {
            "code": "AF",
            "name": "Afghanistan"
        },
        {
            "code": "AX",
            "name": "Ãƒâ€¦land Islands"
        },
        {
            "code": "AL",
            "name": "Albania"
        },
        {
            "code": "DZ",
            "name": "Algeria"
        },
        {
            "code": "AS",
            "name": "American Samoa"
        },
        {
            "code": "AD",
            "name": "AndorrA"
        },
        {
            "code": "AO",
            "name": "Angola"
        },
        {
            "code": "AI",
            "name": "Anguilla"
        },
        {
            "code": "AQ",
            "name": "Antarctica"
        },
        {
            "code": "AG",
            "name": "Antigua and Barbuda"
        },
        {
            "code": "AR",
            "name": "Argentina"
        },
        {
            "code": "AM",
            "name": "Armenia"
        },
        {
            "code": "AW",
            "name": "Aruba"
        },
        {
            "code": "AU",
            "name": "Australia"
        },
        {
            "code": "AT",
            "name": "Austria"
        },
        {
            "code": "AZ",
            "name": "Azerbaijan"
        },
        {
            "code": "BS",
            "name": "Bahamas"
        },
        {
            "code": "BH",
            "name": "Bahrain"
        },
        {
            "code": "BD",
            "name": "Bangladesh"
        },
        {
            "code": "BB",
            "name": "Barbados"
        },
        {
            "code": "BY",
            "name": "Belarus"
        },
        {
            "code": "BE",
            "name": "Belgium"
        },
        {
            "code": "BZ",
            "name": "Belize"
        },
        {
            "code": "BJ",
            "name": "Benin"
        },
        {
            "code": "BM",
            "name": "Bermuda"
        },
        {
            "code": "BT",
            "name": "Bhutan"
        },
        {
            "code": "BO",
            "name": "Bolivia"
        },
        {
            "code": "BA",
            "name": "Bosnia and Herzegovina"
        },
        {
            "code": "BW",
            "name": "Botswana"
        },
        {
            "code": "BV",
            "name": "Bouvet Island"
        },
        {
            "code": "BR",
            "name": "Brazil"
        },
        {
            "code": "IO",
            "name": "British Indian Ocean Territory"
        },
        {
            "code": "BN",
            "name": "Brunei Darussalam"
        },
        {
            "code": "BG",
            "name": "Bulgaria"
        },
        {
            "code": "BF",
            "name": "Burkina Faso"
        },
        {
            "code": "BI",
            "name": "Burundi"
        },
        {
            "code": "KH",
            "name": "Cambodia"
        },
        {
            "code": "CM",
            "name": "Cameroon"
        },
        {
            "code": "CA",
            "name": "Canada"
        },
        {
            "code": "CV",
            "name": "Cape Verde"
        },
        {
            "code": "KY",
            "name": "Cayman Islands"
        },
        {
            "code": "CF",
            "name": "Central African Republic"
        },
        {
            "code": "TD",
            "name": "Chad"
        },
        {
            "code": "CL",
            "name": "Chile"
        },
        {
            "code": "CN",
            "name": "China"
        },
        {
            "code": "CX",
            "name": "Christmas Island"
        },
        {
            "code": "CC",
            "name": "Cocos (Keeling) Islands"
        },
        {
            "code": "CO",
            "name": "Colombia"
        },
        {
            "code": "KM",
            "name": "Comoros"
        },
        {
            "code": "CG",
            "name": "Congo"
        },
        {
            "code": "CD",
            "name": "Congo, The Democratic Republic of the"
        },
        {
            "code": "CK",
            "name": "Cook Islands"
        },
        {
            "code": "CR",
            "name": "Costa Rica"
        },
        {
            "code": "CI",
            "name": "Cote D\\'Ivoire"
        },
        {
            "code": "HR",
            "name": "Croatia"
        },
        {
            "code": "CU",
            "name": "Cuba"
        },
        {
            "code": "CY",
            "name": "Cyprus"
        },
        {
            "code": "CZ",
            "name": "Czech Republic"
        },
        {
            "code": "DK",
            "name": "Denmark"
        },
        {
            "code": "DJ",
            "name": "Djibouti"
        },
        {
            "code": "DM",
            "name": "Dominica"
        },
        {
            "code": "DO",
            "name": "Dominican Republic"
        },
        {
            "code": "EC",
            "name": "Ecuador"
        },
        {
            "code": "EG",
            "name": "Egypt"
        },
        {
            "code": "SV",
            "name": "El Salvador"
        },
        {
            "code": "GQ",
            "name": "Equatorial Guinea"
        },
        {
            "code": "ER",
            "name": "Eritrea"
        },
        {
            "code": "EE",
            "name": "Estonia"
        },
        {
            "code": "ET",
            "name": "Ethiopia"
        },
        {
            "code": "FK",
            "name": "Falkland Islands (Malvinas)"
        },
        {
            "code": "FO",
            "name": "Faroe Islands"
        },
        {
            "code": "FJ",
            "name": "Fiji"
        },
        {
            "code": "FI",
            "name": "Finland"
        },
        {
            "code": "FR",
            "name": "France"
        },
        {
            "code": "GF",
            "name": "French Guiana"
        },
        {
            "code": "PF",
            "name": "French Polynesia"
        },
        {
            "code": "TF",
            "name": "French Southern Territories"
        },
        {
            "code": "GA",
            "name": "Gabon"
        },
        {
            "code": "GM",
            "name": "Gambia"
        },
        {
            "code": "GE",
            "name": "Georgia"
        },
        {
            "code": "DE",
            "name": "Germany"
        },
        {
            "code": "GH",
            "name": "Ghana"
        },
        {
            "code": "GI",
            "name": "Gibraltar"
        },
        {
            "code": "GR",
            "name": "Greece"
        },
        {
            "code": "GL",
            "name": "Greenland"
        },
        {
            "code": "GD",
            "name": "Grenada"
        },
        {
            "code": "GP",
            "name": "Guadeloupe"
        },
        {
            "code": "GU",
            "name": "Guam"
        },
        {
            "code": "GT",
            "name": "Guatemala"
        },
        {
            "code": "GG",
            "name": "Guernsey"
        },
        {
            "code": "GN",
            "name": "Guinea"
        },
        {
            "code": "GW",
            "name": "Guinea-Bissau"
        },
        {
            "code": "GY",
            "name": "Guyana"
        },
        {
            "code": "HT",
            "name": "Haiti"
        },
        {
            "code": "HM",
            "name": "Heard Island and Mcdonald Islands"
        },
        {
            "code": "VA",
            "name": "Holy See (Vatican City State)"
        },
        {
            "code": "HN",
            "name": "Honduras"
        },
        {
            "code": "HK",
            "name": "Hong Kong"
        },
        {
            "code": "HU",
            "name": "Hungary"
        },
        {
            "code": "IS",
            "name": "Iceland"
        },
        {
            "code": "IN",
            "name": "India"
        },
        {
            "code": "ID",
            "name": "Indonesia"
        },
        {
            "code": "IR",
            "name": "Iran, Islamic Republic Of"
        },
        {
            "code": "IQ",
            "name": "Iraq"
        },
        {
            "code": "IE",
            "name": "Ireland"
        },
        {
            "code": "IM",
            "name": "Isle of Man"
        },
        {
            "code": "IL",
            "name": "Israel"
        },
        {
            "code": "IT",
            "name": "Italy"
        },
        {
            "code": "JM",
            "name": "Jamaica"
        },
        {
            "code": "JP",
            "name": "Japan"
        },
        {
            "code": "JE",
            "name": "Jersey"
        },
        {
            "code": "JO",
            "name": "Jordan"
        },
        {
            "code": "KZ",
            "name": "Kazakhstan"
        },
        {
            "code": "KE",
            "name": "Kenya"
        },
        {
            "code": "KI",
            "name": "Kiribati"
        },
        {
            "code": "KP",
            "name": "Korea, Democratic People\\'S Republic of"
        },
        {
            "code": "KR",
            "name": "Korea, Republic of"
        },
        {
            "code": "KW",
            "name": "Kuwait"
        },
        {
            "code": "KG",
            "name": "Kyrgyzstan"
        },
        {
            "code": "LA",
            "name": "Lao People\\'S Democratic Republic"
        },
        {
            "code": "LV",
            "name": "Latvia"
        },
        {
            "code": "LB",
            "name": "Lebanon"
        },
        {
            "code": "LS",
            "name": "Lesotho"
        },
        {
            "code": "LR",
            "name": "Liberia"
        },
        {
            "code": "LY",
            "name": "Libyan Arab Jamahiriya"
        },
        {
            "code": "LI",
            "name": "Liechtenstein"
        },
        {
            "code": "LT",
            "name": "Lithuania"
        },
        {
            "code": "LU",
            "name": "Luxembourg"
        },
        {
            "code": "MO",
            "name": "Macao"
        },
        {
            "code": "MK",
            "name": "Macedonia, The Former Yugoslav Republic of"
        },
        {
            "code": "MG",
            "name": "Madagascar"
        },
        {
            "code": "MW",
            "name": "Malawi"
        },
        {
            "code": "MY",
            "name": "Malaysia"
        },
        {
            "code": "MV",
            "name": "Maldives"
        },
        {
            "code": "ML",
            "name": "Mali"
        },
        {
            "code": "MT",
            "name": "Malta"
        },
        {
            "code": "MH",
            "name": "Marshall Islands"
        },
        {
            "code": "MQ",
            "name": "Martinique"
        },
        {
            "code": "MR",
            "name": "Mauritania"
        },
        {
            "code": "MU",
            "name": "Mauritius"
        },
        {
            "code": "YT",
            "name": "Mayotte"
        },
        {
            "code": "MX",
            "name": "Mexico"
        },
        {
            "code": "FM",
            "name": "Micronesia, Federated States of"
        },
        {
            "code": "MD",
            "name": "Moldova, Republic of"
        },
        {
            "code": "MC",
            "name": "Monaco"
        },
        {
            "code": "MN",
            "name": "Mongolia"
        },
        {
            "code": "MS",
            "name": "Montserrat"
        },
        {
            "code": "MA",
            "name": "Morocco"
        },
        {
            "code": "MZ",
            "name": "Mozambique"
        },
        {
            "code": "MM",
            "name": "Myanmar"
        },
        {
            "code": "NA",
            "name": "Namibia"
        },
        {
            "code": "NR",
            "name": "Nauru"
        },
        {
            "code": "NP",
            "name": "Nepal"
        },
        {
            "code": "NL",
            "name": "Netherlands"
        },
        {
            "code": "AN",
            "name": "Netherlands Antilles"
        },
        {
            "code": "NC",
            "name": "New Caledonia"
        },
        {
            "code": "NZ",
            "name": "New Zealand"
        },
        {
            "code": "NI",
            "name": "Nicaragua"
        },
        {
            "code": "NE",
            "name": "Niger"
        },
        {
            "code": "NG",
            "name": "Nigeria"
        },
        {
            "code": "NU",
            "name": "Niue"
        },
        {
            "code": "NF",
            "name": "Norfolk Island"
        },
        {
            "code": "MP",
            "name": "Northern Mariana Islands"
        },
        {
            "code": "NO",
            "name": "Norway"
        },
        {
            "code": "OM",
            "name": "Oman"
        },
        {
            "code": "PK",
            "name": "Pakistan"
        },
        {
            "code": "PW",
            "name": "Palau"
        },
        {
            "code": "PS",
            "name": "Palestinian Territory, Occupied"
        },
        {
            "code": "PA",
            "name": "Panama"
        },
        {
            "code": "PG",
            "name": "Papua New Guinea"
        },
        {
            "code": "PY",
            "name": "Paraguay"
        },
        {
            "code": "PE",
            "name": "Peru"
        },
        {
            "code": "PH",
            "name": "Philippines"
        },
        {
            "code": "PN",
            "name": "Pitcairn"
        },
        {
            "code": "PL",
            "name": "Poland"
        },
        {
            "code": "PT",
            "name": "Portugal"
        },
        {
            "code": "PR",
            "name": "Puerto Rico"
        },
        {
            "code": "QA",
            "name": "Qatar"
        },
        {
            "code": "RE",
            "name": "Reunion"
        },
        {
            "code": "RO",
            "name": "Romania"
        },
        {
            "code": "RU",
            "name": "Russian Federation"
        },
        {
            "code": "RW",
            "name": "RWANDA"
        },
        {
            "code": "SH",
            "name": "Saint Helena"
        },
        {
            "code": "KN",
            "name": "Saint Kitts and Nevis"
        },
        {
            "code": "LC",
            "name": "Saint Lucia"
        },
        {
            "code": "PM",
            "name": "Saint Pierre and Miquelon"
        },
        {
            "code": "VC",
            "name": "Saint Vincent and the Grenadines"
        },
        {
            "code": "WS",
            "name": "Samoa"
        },
        {
            "code": "SM",
            "name": "San Marino"
        },
        {
            "code": "ST",
            "name": "Sao Tome and Principe"
        },
        {
            "code": "SA",
            "name": "Saudi Arabia"
        },
        {
            "code": "SN",
            "name": "Senegal"
        },
        {
            "code": "CS",
            "name": "Serbia and Montenegro"
        },
        {
            "code": "SC",
            "name": "Seychelles"
        },
        {
            "code": "SL",
            "name": "Sierra Leone"
        },
        {
            "code": "SG",
            "name": "Singapore"
        },
        {
            "code": "SK",
            "name": "Slovakia"
        },
        {
            "code": "SI",
            "name": "Slovenia"
        },
        {
            "code": "SB",
            "name": "Solomon Islands"
        },
        {
            "code": "SO",
            "name": "Somalia"
        },
        {
            "code": "ZA",
            "name": "South Africa"
        },
        {
            "code": "GS",
            "name": "South Georgia and the South Sandwich Islands"
        },
        {
            "code": "ES",
            "name": "Spain"
        },
        {
            "code": "LK",
            "name": "Sri Lanka"
        },
        {
            "code": "SD",
            "name": "Sudan"
        },
        {
            "code": "SR",
            "name": "Suriname"
        },
        {
            "code": "SJ",
            "name": "Svalbard and Jan Mayen"
        },
        {
            "code": "SZ",
            "name": "Swaziland"
        },
        {
            "code": "SE",
            "name": "Sweden"
        },
        {
            "code": "CH",
            "name": "Switzerland"
        },
        {
            "code": "SY",
            "name": "Syrian Arab Republic"
        },
        {
            "code": "TW",
            "name": "Taiwan, Province of China"
        },
        {
            "code": "TJ",
            "name": "Tajikistan"
        },
        {
            "code": "TZ",
            "name": "Tanzania, United Republic of"
        },
        {
            "code": "TH",
            "name": "Thailand"
        },
        {
            "code": "TL",
            "name": "Timor-Leste"
        },
        {
            "code": "TG",
            "name": "Togo"
        },
        {
            "code": "TK",
            "name": "Tokelau"
        },
        {
            "code": "TO",
            "name": "Tonga"
        },
        {
            "code": "TT",
            "name": "Trinidad and Tobago"
        },
        {
            "code": "TN",
            "name": "Tunisia"
        },
        {
            "code": "TR",
            "name": "Turkey"
        },
        {
            "code": "TM",
            "name": "Turkmenistan"
        },
        {
            "code": "TC",
            "name": "Turks and Caicos Islands"
        },
        {
            "code": "TV",
            "name": "Tuvalu"
        },
        {
            "code": "UG",
            "name": "Uganda"
        },
        {
            "code": "UA",
            "name": "Ukraine"
        },
        {
            "code": "AE",
            "name": "United Arab Emirates"
        },
        {
            "code": "GB",
            "name": "United Kingdom"
        },
        {
            "code": "US",
            "name": "United States"
        },
        {
            "code": "UM",
            "name": "United States Minor Outlying Islands"
        },
        {
            "code": "UY",
            "name": "Uruguay"
        },
        {
            "code": "UZ",
            "name": "Uzbekistan"
        },
        {
            "code": "VU",
            "name": "Vanuatu"
        },
        {
            "code": "VE",
            "name": "Venezuela"
        },
        {
            "code": "VN",
            "name": "Viet Nam"
        },
        {
            "code": "VG",
            "name": "Virgin Islands, British"
        },
        {
            "code": "VI",
            "name": "Virgin Islands, U.S."
        },
        {
            "code": "WF",
            "name": "Wallis and Futuna"
        },
        {
            "code": "EH",
            "name": "Western Sahara"
        },
        {
            "code": "YE",
            "name": "Yemen"
        },
        {
            "code": "ZM",
            "name": "Zambia"
        },
        {
            "code": "ZW",
            "name": "Zimbabwe"
        }
    ]
}

Received response:

Request failed with error:

Show all base elements

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/element"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/element" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display constructions available for project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/construction"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/construction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display categories available for project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/construction/4/category"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/construction/4/category" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display elements available for project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/construction/18/category/7/element"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/construction/18/category/7/element" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/construction/{construction_id}/category/{category_id}/element

URL Parameters

construction_id integer

The ID of the construction.

category_id integer

The ID of the category.

construction integer

This is the id for the construction

category integer

This is the id for the category

Display items available for project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/element/1/item"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/element/1/item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Invoice controller

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoices"
);

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

let body = {
    "items": 3,
    "search": "voluptatem",
    "invoice_type": "ullam",
    "status": [
        "et"
    ],
    "type": [
        "minima"
    ]
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/invoices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 3,
    \"search\": \"voluptatem\",
    \"invoice_type\": \"ullam\",
    \"status\": [
        \"et\"
    ],
    \"type\": [
        \"minima\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/invoices

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

invoice_type string optional

status string[] optional

type string[] optional

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoices"
);

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

let body = {
    "invoice_type": "qui"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/invoices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_type\": \"qui\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoices/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/invoices/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoices/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/invoices/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoices/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/invoices/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Issue controller

Display a listing of the issue.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues"
);

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

let body = {
    "items": 1,
    "search": "id",
    "project": 14
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/issues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 1,
    \"search\": \"id\",
    \"project\": 14
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified issue.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/issues/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the issue.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/similique/issues"
);

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

let body = {
    "items": 7,
    "search": "nihil",
    "project": 5
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/similique/issues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 7,
    \"search\": \"nihil\",
    \"project\": 5
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created issue in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/sit/issues"
);

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

let body = {
    "name": "ducimus",
    "desr": "odit",
    "impact": [
        "quam"
    ],
    "issue_type": "architecto",
    "indentifiers": [
        "aut"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/sit/issues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ducimus\",
    \"desr\": \"odit\",
    \"impact\": [
        \"quam\"
    ],
    \"issue_type\": \"architecto\",
    \"indentifiers\": [
        \"aut\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/project/{project}/issues

URL Parameters

project string

The project.

Body Parameters

name string

desr string

impact string[]

issue_type string

indentifiers string[] optional

minute_id string optional

Display the specified issue.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/voluptate/issues/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/voluptate/issues/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified issue in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/labore/issues/1"
);

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

let body = {
    "impact": [
        "iusto"
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/labore/issues/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"impact\": [
        \"iusto\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{project_id}/issues/{id}

PATCH api/project/{project_id}/issues/{id}

URL Parameters

project_id string

The ID of the project.

id integer

The ID of the issue.

Body Parameters

name string optional

desr string optional

impact string[] optional

cost string optional

time string optional

status string optional

indentifiers string optional

affected_desc string optional

new_scope_item string optional

submitted_status string optional

approved_status string optional

Remove the specified issue from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/officia/issues/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/officia/issues/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Isuue comments management

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1/comments"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/issues/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1/comments"
);

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

let body = {
    "desr": "quo"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/issues/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"quo\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1/comments/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/issues/1/comments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1/comments/1"
);

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

let body = {
    "desr": "assumenda"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/issues/1/comments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"assumenda\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/issues/1/comments/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/issues/1/comments/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

License Management

Display license from license table.

requires authentication

This endpoint allows you see license details.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/license/10/license-details"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/license/10/license-details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Displays Whether A Team Has A License

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/license/10/team-license"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/license/10/team-license" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Generate A License For The Organisation team.

requires authentication

This endpoint allows you to assign a license to a team .

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/license/create-license"
);

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

let body = {
    "team_id": 16,
    "license_id": 20
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/license/create-license" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"team_id\": 16,
    \"license_id\": 20
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Revoke License

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/license/revoke-license"
);

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

let body = {
    "receiver_id": 11
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/license/revoke-license" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"receiver_id\": 11
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/invoice-updated-webhook

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoice-updated-webhook"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/invoice-updated-webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 586
vary: Origin


{
    "status": 200,
    "success": true,
    "data": null
}

Received response:

Request failed with error:

POST api/invoice-updated-webhook

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/invoice-updated-webhook"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/invoice-updated-webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 585
vary: Origin


{
    "status": 200,
    "success": true,
    "data": null
}

Received response:

Request failed with error:

GET api/pabbly

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/pabbly"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/pabbly" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 584
vary: Origin


{
    "status": 200,
    "success": true,
    "data": null
}

Received response:

Request failed with error:

POST api/pabbly

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/pabbly"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/pabbly" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 583
vary: Origin


{
    "status": 200,
    "success": true,
    "data": null
}

Received response:

Request failed with error:

Material controller

Display a listing of the material.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/materials"
);

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

let body = {
    "items": 9,
    "search": "ut",
    "project_list_id": 8,
    "purchase_id": 19,
    "issue_id": 12
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/materials" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 9,
    \"search\": \"ut\",
    \"project_list_id\": 8,
    \"purchase_id\": 19,
    \"issue_id\": 12
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/materials

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

project_list_id integer optional

purchase_id integer optional

issue_id integer optional

Store a newly created material in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/materials"
);

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

let body = {
    "purchase_id": "dolor",
    "project_list_id": "et"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/materials" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"purchase_id\": \"dolor\",
    \"project_list_id\": \"et\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified material.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/materials/18"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/materials/18" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified material in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/materials/5"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/materials/5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified material from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/materials/14"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/materials/14" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Memo-minutes Controller

Display a listing of the memo.

@authenticated

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/quasi/meetings"
);

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

let body = {
    "items": 13,
    "search": "nihil",
    "project": 9
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/quasi/meetings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 13,
    \"search\": \"nihil\",
    \"project\": 9
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created memo in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/molestiae/meetings"
);

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

let body = {
    "meeting_date": "22-04-2024",
    "minutes": [
        {
            "agenda_data": [
                {
                    "description": "quia",
                    "points": "iusto",
                    "action": "eligendi",
                    "due_date": "quas",
                    "responsbilities": [
                        {
                            "name": "officiis",
                            "id": 71107200
                        }
                    ]
                }
            ]
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/molestiae/meetings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"meeting_date\": \"22-04-2024\",
    \"minutes\": [
        {
            \"agenda_data\": [
                {
                    \"description\": \"quia\",
                    \"points\": \"iusto\",
                    \"action\": \"eligendi\",
                    \"due_date\": \"quas\",
                    \"responsbilities\": [
                        {
                            \"name\": \"officiis\",
                            \"id\": 71107200
                        }
                    ]
                }
            ]
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/project/{project}/meetings

URL Parameters

project string

The project.

Body Parameters

minute_header string optional

meeting_date string optional

Must be a valid date. Must be a valid date in the format d-m-Y.

minutes object[] optional

minutes[].agenda_data object[] optional

minutes[].agenda_data[].description string

minutes[].agenda_data[].points string

minutes[].agenda_data[].action string

minutes[].agenda_data[].due_date string

minutes[].agenda_data[].responsbilities object[] optional

minutes[].agenda_data[].responsbilities[].name string

minutes[].agenda_data[].responsbilities[].id number

Display the specified memo.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/eos/meetings/velit"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/eos/meetings/velit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the memo.

Update the meeting date

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/mollitia/meetings/deserunt"
);

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

let body = {
    "meeting_date": "22-04-2024"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/mollitia/meetings/deserunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"meeting_date\": \"22-04-2024\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified memo from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/quo/meetings/porro"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/quo/meetings/porro" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Sign a memo

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/exercitationem/sign"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/meetings/exercitationem/sign" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a listing of the memo.

@authenticated

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings"
);

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

let body = {
    "items": 3,
    "search": "rem",
    "project": 15
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/meetings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 3,
    \"search\": \"rem\",
    \"project\": 15
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get all agendas to use in the memos

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/agendas"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/agendas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Minute management

CRUD for minute

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/accusamus/minutes"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/meetings/accusamus/minutes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/quaerat/minutes"
);

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

let body = {
    "agenda": "eum",
    "description": "dolorum",
    "points": "quo",
    "action": "laboriosam",
    "due_date": "qui",
    "responsbilities": [
        {
            "name": "voluptatem",
            "id": 19124184
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/meetings/quaerat/minutes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"agenda\": \"eum\",
    \"description\": \"dolorum\",
    \"points\": \"quo\",
    \"action\": \"laboriosam\",
    \"due_date\": \"qui\",
    \"responsbilities\": [
        {
            \"name\": \"voluptatem\",
            \"id\": 19124184
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/meetings/{meeting}/minutes

URL Parameters

meeting string

The meeting.

Body Parameters

agenda string

description string

points string

action string

due_date string

responsbilities object[] optional

responsbilities[].name string

responsbilities[].id number

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/consectetur/minutes/2"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/meetings/consectetur/minutes/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/eligendi/minutes/2"
);

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

let body = {
    "agenda": "fuga",
    "description": "reprehenderit",
    "points": "deserunt",
    "action": "distinctio",
    "due_date": "pariatur",
    "responsbilities": [
        {
            "name": "molestiae",
            "id": 647876664.5666096
        }
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/meetings/eligendi/minutes/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"agenda\": \"fuga\",
    \"description\": \"reprehenderit\",
    \"points\": \"deserunt\",
    \"action\": \"distinctio\",
    \"due_date\": \"pariatur\",
    \"responsbilities\": [
        {
            \"name\": \"molestiae\",
            \"id\": 647876664.5666096
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/meetings/{meeting_id}/minutes/{id}

PATCH api/meetings/{meeting_id}/minutes/{id}

URL Parameters

meeting_id string

The ID of the meeting.

id integer

The ID of the minute.

Body Parameters

agenda string optional

description string optional

points string optional

action string optional

due_date string optional

responsbilities object[] optional

responsbilities[].name string optional

responsbilities[].id number optional

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/meetings/dolorum/minutes/2"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/meetings/dolorum/minutes/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Portfolio management

Display a listing of the portfolio.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/portfolios"
);

const params = {
    "items": "11",
    "order": "cumque",
    "sort": "explicabo",
    "search": "ad",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "project_id": "omnis",
    "items": 2,
    "search": "ipsa"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/portfolios?items=11&order=cumque&sort=explicabo&search=ad" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": \"omnis\",
    \"items\": 2,
    \"search\": \"ipsa\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/portfolios

Query Parameters

items integer optional

This is how many results are returned

order string optional

Order by asc or desc

sort string optional

Sort by created_at , updated_at or id

search string optional

Search string

Body Parameters

project_id string optional

items integer optional

order string optional

sort string optional

search string optional

Store a newly created portfolio in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/portfolios"
);

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

let body = {
    "project_id": [
        "velit"
    ],
    "desr": "nihil"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/portfolios" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": [
        \"velit\"
    ],
    \"desr\": \"nihil\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified portfolio.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/portfolios/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/portfolios/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified portfolio in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/portfolios/1"
);

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

let body = {
    "desr": "in",
    "layout": [
        "commodi"
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/portfolios/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"in\",
    \"layout\": [
        \"commodi\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/portfolios/{id}

PATCH api/portfolios/{id}

URL Parameters

id integer

The ID of the portfolio.

portfolio integer

This is the id of the portfolio

Body Parameters

desr string

This is the name of the portfolio

layout string[] optional

These are the keys to show on report such as "unapproved_change": true,

Remove the specified portfolio from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/portfolios/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/portfolios/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Preliminary management

Apis for managing preliminaries of a boq

Display the default preliminaries for the construction type specified.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/preliminaries"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/preliminaries" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display all preliminaries.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/preliminary"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/preliminary" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Profile controller

Manage profile settings

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/profiles"
);

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

let body = {
    "items": 1,
    "search": "illum"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/profiles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 1,
    \"search\": \"illum\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/profiles"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/profiles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/profiles/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/profiles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/profiles/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/profiles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/profiles/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/profiles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Project Permission Management

GET api/sync-all-projects

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/sync-all-projects"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/sync-all-projects" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):

Show headers

content-type: text/html; charset=UTF-8
cache-control: no-cache, private
x-ratelimit-limit: 600
x-ratelimit-remaining: 592
vary: Origin

Received response:

Request failed with error:

GET api/user/sync-projects

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/sync-projects"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/sync-projects" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Project permission

Get all the project permissions assigned to this project

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/corporis/users"
);

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

let body = {
    "user": 0.46635,
    "team": 9498072.952
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/corporis/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user\": 0.46635,
    \"team\": 9498072.952
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Add a user to the resource project

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/iste/users"
);

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

let body = {
    "user": 9065,
    "team": 30.826507769,
    "permission": [
        {
            "page": "qui",
            "pageView": false,
            "processes": [
                "mollitia"
            ]
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/iste/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user\": 9065,
    \"team\": 30.826507769,
    \"permission\": [
        {
            \"page\": \"qui\",
            \"pageView\": false,
            \"processes\": [
                \"mollitia\"
            ]
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/project/{project}/users

URL Parameters

project string

The project.

Body Parameters

user number

team number

permission object[] optional

permission[].page string

permission[].pageView boolean

permission[].processes string[]

Update the user permissions on the project resource

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/dolore/users/1"
);

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

let body = {
    "team": 13580972,
    "permission": [
        {
            "page": "velit",
            "pageView": false,
            "processes": [
                "qui"
            ]
        }
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/dolore/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"team\": 13580972,
    \"permission\": [
        {
            \"page\": \"velit\",
            \"pageView\": false,
            \"processes\": [
                \"qui\"
            ]
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{project_id}/users/{id}

PATCH api/project/{project_id}/users/{id}

URL Parameters

project_id string

The ID of the project.

id integer

The ID of the user.

Body Parameters

team number

permission object[] optional

permission[].page string

permission[].pageView boolean

permission[].processes string[]

Delete the user permissions on the project resource

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/velit/users/1"
);

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

let body = {
    "team": 263907.005737,
    "permission": [
        {
            "page": "ratione",
            "pageView": true,
            "processes": [
                "soluta"
            ]
        }
    ]
};

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/velit/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"team\": 263907.005737,
    \"permission\": [
        {
            \"page\": \"ratione\",
            \"pageView\": true,
            \"processes\": [
                \"soluta\"
            ]
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

DELETE api/project/{project_id}/users/{id}

URL Parameters

project_id string

The ID of the project.

id integer

The ID of the user.

Body Parameters

team number

permission object[] optional

permission[].page string

permission[].pageView boolean

permission[].processes string[]

Project management

Copy the project from another existing project

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/2/copy"
);

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

let body = {
    "desr": "harum",
    "project_list_id": 15
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/2/copy" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"harum\",
    \"project_list_id\": 15
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Copy the project bill from another existing project

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/19/bill-copy"
);

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

let body = {
    "desr": "dolor",
    "project_list_id": 5
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/19/bill-copy" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"dolor\",
    \"project_list_id\": 5
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

POST api/project/{project}/collaborate

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/voluptas/collaborate"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/project/voluptas/collaborate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display all projects for the current team of the user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project"
);

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

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

let body = {
    "items": 6,
    "search": "quo",
    "recent": "cost",
    "plans": true,
    "filter": "no_take_off"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project?recent=bills" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 6,
    \"search\": \"quo\",
    \"recent\": \"cost\",
    \"plans\": true,
    \"filter\": \"no_take_off\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/project

Query Parameters

recent string optional

This enables you to specify the recent project relating to a module such as bills,projects,cost,finalized,shared and take-offs.

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

recent string optional

Must be one of bills, projects, take-offs, cost, finalized, or shared.

plans boolean optional

filter string optional

Must be one of no_take_off, no_bill, or no_bid.

Create a new project in the current team of the user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project"
);

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

let body = {
    "desr": "sapiente",
    "project_properties": {
        "construction": "dolorem",
        "basement": false,
        "pilling": true
    },
    "type": "ipsam",
    "allocation": [
        {
            "category": 7,
            "user_id": 14
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/project" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"sapiente\",
    \"project_properties\": {
        \"construction\": \"dolorem\",
        \"basement\": false,
        \"pilling\": true
    },
    \"type\": \"ipsam\",
    \"allocation\": [
        {
            \"category\": 7,
            \"user_id\": 14
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/project

Body Parameters

desr string

This is the description of the project.

project_properties object optional

These are the construction properties.

project_properties.construction string

This is the construction type.

project_properties.basement boolean

Does the construction have basement?.

project_properties.pilling boolean optional

Does the construction have pilling?.

type string

Is the project funnel? Straight or funnel.

allocation object[] optional

Assignment of the categories to the team members.

allocation[].category integer

This the category id for the project.

allocation[].user_id integer

This the user id of the team member.

Display the specified resource.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/non"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update specified project

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/sequi"
);

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

let body = {
    "desr": "architecto",
    "project_properties": {
        "construction": "quo",
        "basement": true,
        "pilling": false
    },
    "allocation": [
        {
            "category": 13,
            "user_id": 9
        }
    ],
    "location": "eos",
    "status": "magnam",
    "duration": "distinctio",
    "duration_unit": "hour"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/sequi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"architecto\",
    \"project_properties\": {
        \"construction\": \"quo\",
        \"basement\": true,
        \"pilling\": false
    },
    \"allocation\": [
        {
            \"category\": 13,
            \"user_id\": 9
        }
    ],
    \"location\": \"eos\",
    \"status\": \"magnam\",
    \"duration\": \"distinctio\",
    \"duration_unit\": \"hour\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{id}

PATCH api/project/{id}

URL Parameters

id string

The ID of the project.

Body Parameters

desr string optional

project_properties object optional

These are the construction properties.

project_properties.construction string

This is the construction type.

project_properties.basement boolean

Does the construction have basement?.

project_properties.pilling boolean optional

Does the construction have pilling?.

type string optional

allocation object[] optional

Assignment of the categories to the team members.

allocation[].category integer

This the category id for the project.

allocation[].user_id integer

This the user id of the team member.

location string optional

status string optional

duration string optional

duration_unit string optional

Must be one of day or hour.

Remove the specified resource from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/architecto"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Upload legacy project into Rapisurv

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/legacy/bid"
);

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

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/legacy/bid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "project_list_id=20" \
    --form "document=@C:\Users\crevi\AppData\Local\Temp\phpB809.tmp"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display all elements that are available for the project to use according to the construction type.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/9/element"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/9/element?used=" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Project report management

Display the financial plan report

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/6/financial-plan"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/6/financial-plan" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Financial performance report

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/16/financial-performance"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/16/financial-performance" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Capacity utilization report

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/19/capacity-utillization"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/19/capacity-utillization" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Plan forecast comparison

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/17/forecast-comparison"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/17/forecast-comparison" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Purchase management

Display a listing of the purchases.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases"
);

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

let body = {
    "items": 17,
    "search": "iste",
    "project_list_id": 8,
    "type": [
        "id"
    ],
    "location": "reiciendis",
    "status": [
        "est"
    ]
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/purchases" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 17,
    \"search\": \"iste\",
    \"project_list_id\": 8,
    \"type\": [
        \"id\"
    ],
    \"location\": \"reiciendis\",
    \"status\": [
        \"est\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/purchases

Body Parameters

items integer optional

order string optional

sort string optional

search string optional

project_list_id integer optional

type string[] optional

location string optional

status string[] optional

Store a newly created purchases in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases"
);

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

let body = {
    "project_list_id": "occaecati",
    "items": [
        {
            "qty": 0,
            "rate": 0,
            "amount": 0,
            "unit": "quam",
            "unit_id": 2,
            "material_id": 18,
            "item_description": "placeat",
            "link_desc": "id"
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/purchases" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_list_id\": \"occaecati\",
    \"items\": [
        {
            \"qty\": 0,
            \"rate\": 0,
            \"amount\": 0,
            \"unit\": \"quam\",
            \"unit_id\": 2,
            \"material_id\": 18,
            \"item_description\": \"placeat\",
            \"link_desc\": \"id\"
        }
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/purchases

Body Parameters

project_list_id string

demand_id string optional

items object[] optional

items[].qty integer optional

Must be at least 0.

items[].rate integer optional

Must be at least 0.

items[].amount integer optional

Must be at least 0.

items[].unit string optional

items[].unit_id integer

items[].material_id integer

items[].item_description string optional

items[].link_desc string optional

Display the specified purchases.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/purchases/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified purchases in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/purchases/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified purchases from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/purchases/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases|invoices|demands|folders/enim/share"
);

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

const body = new FormData();
body.append('type', 'collaborator');
body.append('email[]', 'katharina.erdman@example.org');
body.append('file[]', document.querySelector('input[name="file[]"]').files[0]);

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

curl --request POST \
    "http://rapidserv.local:8000/api/purchases|invoices|demands|folders/enim/share" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "type=collaborator" \
    --form "email[]=katharina.erdman@example.org" \
    --form "file[]=@C:\Users\crevi\AppData\Local\Temp\phpA2B4.tmp"

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\AbstractRouteCollection.php",
    "line": 43,
    "trace": [
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\RouteCollection.php",
            "line": 162,
            "function": "handleMatchedRoute",
            "class": "Illuminate\\Routing\\AbstractRouteCollection",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 673,
            "function": "match",
            "class": "Illuminate\\Routing\\RouteCollection",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 662,
            "function": "findRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 651,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 167,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\livewire\\livewire\\src\\DisableBrowserCache.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Livewire\\DisableBrowserCache",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fruitcake\\laravel-cors\\src\\HandleCors.php",
            "line": 52,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fideloper\\proxy\\src\\TrustProxies.php",
            "line": 57,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fideloper\\Proxy\\TrustProxies",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 142,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 111,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 179,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Commands\\GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Util.php",
            "line": 40,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 37,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 653,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 136,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Command\\Command.php",
            "line": 298,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 121,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 1040,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 301,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 171,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Application.php",
            "line": 94,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Console\\Kernel.php",
            "line": 129,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\artisan",
            "line": 37,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}

Received response:

Request failed with error:

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/purchases|invoices|demands|folders/quisquam/share"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/purchases|invoices|demands|folders/quisquam/share" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (404):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\AbstractRouteCollection.php",
    "line": 43,
    "trace": [
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\RouteCollection.php",
            "line": 162,
            "function": "handleMatchedRoute",
            "class": "Illuminate\\Routing\\AbstractRouteCollection",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 673,
            "function": "match",
            "class": "Illuminate\\Routing\\RouteCollection",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 662,
            "function": "findRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 651,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 167,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 128,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\livewire\\livewire\\src\\DisableBrowserCache.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Livewire\\DisableBrowserCache",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fruitcake\\laravel-cors\\src\\HandleCors.php",
            "line": 52,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\fideloper\\proxy\\src\\TrustProxies.php",
            "line": 57,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Fideloper\\Proxy\\TrustProxies",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 103,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 142,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 111,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 179,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\knuckleswtf\\scribe\\src\\Commands\\GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Util.php",
            "line": 40,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 37,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 653,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 136,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Command\\Command.php",
            "line": 298,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 121,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 1040,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 301,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\symfony\\console\\Application.php",
            "line": 171,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Application.php",
            "line": 94,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Console\\Kernel.php",
            "line": 129,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "D:\\projects\\rapiserv\\artisan",
            "line": 37,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}

Received response:

Request failed with error:

Rate sheet management

Display all the rate sheets for the users organisation.

requires authentication

This api allows query parameter for ordering items

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/rate-sheet"
);

const params = {
    "sort": "ad",
    "items": "12",
    "order": "in",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "items": 17
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/rate-sheet?sort=ad&items=12&order=in" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 17
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/rate-sheet

Query Parameters

sort string optional

This can be created_at, updated_at or id

items integer optional

This is number specifying how many items to return

order string optional

This can be desc or asc

Body Parameters

items integer optional

order string optional

sort string optional

Store a newly created rate sheet.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/rate-sheet"
);

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

let body = {
    "data": [
        []
    ],
    "name": "corrupti"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/rate-sheet" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        []
    ],
    \"name\": \"corrupti\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the rate sheet.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/rate-sheet/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/rate-sheet/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified rate sheet in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/rate-sheet/1"
);

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

let body = {
    "data": [
        []
    ],
    "name": "id"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/rate-sheet/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        []
    ],
    \"name\": \"id\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified rate sheet from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/rate-sheet/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/rate-sheet/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Setting Management

Display a setting for the current team.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/setting"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/setting" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the settting for the current team.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/setting"
);

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

let body = {
    "base_price_mark_up_percentage": 1.20808,
    "base_price_transport_percentage": 2.028,
    "base_price_handling_percentage": 31.4
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/setting" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"base_price_mark_up_percentage\": 1.20808,
    \"base_price_transport_percentage\": 2.028,
    \"base_price_handling_percentage\": 31.4
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Storage Locations Management

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/storage-locations"
);

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

let body = {
    "items": 10,
    "search": "molestiae",
    "state": "fcvinrenxahcekkndrvgtsbjsgupcovwbxuzqqhakmjtuignqazmuchvsmugrbzbbpxeggwztiomwmxlvskqykxhidmipspdvbunqkrlvcnyhwhbpopnegprnzrdkiujxlfoopuiinrvryqgmurhxueslxgilyjxobtjxp"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/storage-locations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 10,
    \"search\": \"molestiae\",
    \"state\": \"fcvinrenxahcekkndrvgtsbjsgupcovwbxuzqqhakmjtuignqazmuchvsmugrbzbbpxeggwztiomwmxlvskqykxhidmipspdvbunqkrlvcnyhwhbpopnegprnzrdkiujxlfoopuiinrvryqgmurhxueslxgilyjxobtjxp\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/storage-locations"
);

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

let body = {
    "name": "quo",
    "address_id": 7,
    "manager": "distinctio",
    "state": "open"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/storage-locations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quo\",
    \"address_id\": 7,
    \"manager\": \"distinctio\",
    \"state\": \"open\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/storage-locations/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/storage-locations/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/storage-locations/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/storage-locations/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/storage-locations/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/storage-locations/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Subscription Interface

Apis for subscriptions of the users

Get the products which are available for users to buy

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/products"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 593
vary: Origin


{
    "status": 422,
    "success": false,
    "error": {
        "code": 422,
        "message": "We failed to create access url"
    }
}

Received response:

Request failed with error:

Get the checkout pages of the logged in user

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/checkout"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/checkout?product_id=fuga" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/pabbly-login"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/pabbly-login" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/user/subscriptions

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/subscriptions"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/subscriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/user/subscriptions/{subscription}

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/subscriptions/delectus"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/subscriptions/delectus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

POST api/user/subscription/action

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/subscription/action"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/subscription/action" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

POST api/user/subscription/active

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/subscription/active"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/subscription/active" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Take-off management

Update the custom take-off descriptions for this take off.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/takf/1/transactions"
);

const params = {
    "take-off": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "custom_desc": [
        "consequuntur"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/takf/1/transactions?take-off=5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_desc\": [
        \"consequuntur\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the take off of the project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/take-off"
);

const params = {
    "combine": "1",
    "user_id": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "user_id": 4
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/project/705/take-off?combine=1&user_id=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 4
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/project/{project_id}/take-off

URL Parameters

project_id integer

The ID of the project.

Query Parameters

combine boolean optional

This returns all the take offs for all the uses in the funnel.

user_id integer optional

Get specified take off and custom descriptions for the user.

Body Parameters

user_id integer optional

Update the specified resource in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/take-off/reiciendis"
);

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

let body = {
    "data": [],
    "locked": true
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/project/705/take-off/reiciendis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [],
    \"locked\": true
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/project/{project_id}/take-off/{id}

PATCH api/project/{project_id}/take-off/{id}

URL Parameters

project_id integer

The ID of the project.

id string

The ID of the take off.

Body Parameters

data object optional

This is the data of takeoff sheet.

locked boolean

Remove the specified resource from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/project/705/take-off/ad"
);

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

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/project/705/take-off/ad?take_off=16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

All take-offs for this organisation

requires authentication

queryParam items integer This is how many results are returned

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/take-offs"
);

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

let body = {
    "items": 5
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/take-offs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 5
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Take Off Descriptions

Store a newly created take off description in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/item/voluptatum/take-off-desc"
);

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

let body = {
    "desr": "dolore",
    "meas": 17,
    "base_item_id": 17,
    "bill_desc_id": 5,
    "team": [
        6
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/item/voluptatum/take-off-desc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"dolore\",
    \"meas\": 17,
    \"base_item_id\": 17,
    \"bill_desc_id\": 5,
    \"team\": [
        6
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/item/{item}/take-off-desc

URL Parameters

item string

The item.

team integer optional

This is the item id

Body Parameters

desr string

This is the take off descriptiom

meas integer

This is the unit of measurement

base_item_id integer optional

This is the base Item ID

bill_desc_id integer optional

This is the bill description ID

team integer[] optional

This is an array of the team IDs that have acccess to this custom description.

Display the specified resource.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/item/quo/take-off-desc/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/item/quo/take-off-desc/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/item/2/take-off-desc/1"
);

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

let body = {
    "desr": "quis",
    "meas": 18,
    "base_item_id": 19,
    "bill_desc_id": 17,
    "team": [
        17
    ]
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/item/2/take-off-desc/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"desr\": \"quis\",
    \"meas\": 18,
    \"base_item_id\": 19,
    \"bill_desc_id\": 17,
    \"team\": [
        17
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/item/{item_id}/take-off-desc/{id}

PATCH api/item/{item_id}/take-off-desc/{id}

URL Parameters

item_id integer

The ID of the item.

id integer

The ID of the take off desc.

item integer

This is the base item ID

take_off_desc integer

This is the take off description ID

team integer optional

This is the item id

Body Parameters

desr string

This is the take off descriptiom

meas integer

This is the unit of measurement

base_item_id integer optional

This is the base Item ID

bill_desc_id integer optional

This is the bill description ID

team integer[] optional

This is an array of the team IDs that have acccess to this custom description.

Remove the specified resource from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/item/2/take-off-desc/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/item/2/take-off-desc/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display a take-off descriptions for the item specified.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/item/2/take-off-desc"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/item/2/take-off-desc?custom=nobis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Add a custom description.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/custom-desc"
);

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

let body = {
    "bill_desr": "et",
    "take_off_desr": "voluptatem",
    "base_item_id": 13,
    "unit_id": 13,
    "team": [
        "voluptates"
    ],
    "std_code": "quia"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/custom-desc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bill_desr\": \"et\",
    \"take_off_desr\": \"voluptatem\",
    \"base_item_id\": 13,
    \"unit_id\": 13,
    \"team\": [
        \"voluptates\"
    ],
    \"std_code\": \"quia\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

POST api/sync-desc

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/sync-desc"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/sync-desc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Team

Switch to user account to another team.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1/switch"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/team/1/switch?team=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get the current team of the user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/current"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/team/current" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/team/{team_id}/users

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1/users"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/team/1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Invite a user to team whose doesn't have an account.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1/invite"
);

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

let body = {
    "email": "cyril.dicki@example.net"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/team/1/invite" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"cyril.dicki@example.net\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove a user from the team. Example: test@1localhost.com

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1/remove"
);

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

let body = {
    "email": "fritsch.ronaldo@example.net"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/team/1/remove" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"fritsch.ronaldo@example.net\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Add a user to the team whose already a registered user of Rapisurv. Example: test@1localhost.com

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1/add"
);

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

let body = {
    "email": "iboyer@example.com",
    "role": "aut"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/team/1/add" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"iboyer@example.com\",
    \"role\": \"aut\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display all teams of this user.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/team" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created team in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team"
);

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

let body = {
    "name": "ybjijdohkvyrfokgoaqvwwstxjrpebnzybrjlycfruibycfuivddqrntjwjzwtstavwznhfogjxlfkljbluccdhuffpvpwlbqwkjcnkxzgrzeagormoltjwdohizoenubwcrwjjeqoagqzrdjgegwppmlpbqrk",
    "zone": 60322.27766
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/team" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ybjijdohkvyrfokgoaqvwwstxjrpebnzybrjlycfruibycfuivddqrntjwjzwtstavwznhfogjxlfkljbluccdhuffpvpwlbqwkjcnkxzgrzeagormoltjwdohizoenubwcrwjjeqoagqzrdjgegwppmlpbqrk\",
    \"zone\": 60322.27766
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified team.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/team/1?team=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified team in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1"
);

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

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

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/team/1?team=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified team from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/team/1"
);

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

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/team/1?team=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Tender Management

Get all tenders for the organisation.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tender"
);

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

let body = {
    "items": 12
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/tender" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 12
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Create a tender.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tender"
);

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

let body = {
    "bill_id": 19,
    "title": "qui",
    "location": "numquam",
    "customer": "deserunt",
    "surveyor": "quaerat",
    "date": "2024-04-22T20:44:00",
    "document": "odit",
    "client_logo": "beatae",
    "qs_logo": "tempore",
    "preambles": "totam"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/tender" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bill_id\": 19,
    \"title\": \"qui\",
    \"location\": \"numquam\",
    \"customer\": \"deserunt\",
    \"surveyor\": \"quaerat\",
    \"date\": \"2024-04-22T20:44:00\",
    \"document\": \"odit\",
    \"client_logo\": \"beatae\",
    \"qs_logo\": \"tempore\",
    \"preambles\": \"totam\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/tender

Body Parameters

bill_id integer

title string

location string

customer string

surveyor string

date string

Must be a valid date.

document This optional

is used for pasting a document.

client_logo string

qs_logo string

preambles string

'upload_File' => ['mimes:pdf,doc,docx'],.

Display your tender

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tender/1"
);

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

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/tender/1?tender=consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tender/1"
);

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

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

let body = {
    "bill_id": 13,
    "title": "in",
    "location": "incidunt",
    "customer": "maxime",
    "surveyor": "corporis",
    "date": "2024-04-22T20:44:00",
    "document": "maxime",
    "client_logo": "excepturi",
    "qs_logo": "praesentium",
    "preambles": "consequatur"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/tender/1?tender=optio" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bill_id\": 13,
    \"title\": \"in\",
    \"location\": \"incidunt\",
    \"customer\": \"maxime\",
    \"surveyor\": \"corporis\",
    \"date\": \"2024-04-22T20:44:00\",
    \"document\": \"maxime\",
    \"client_logo\": \"excepturi\",
    \"qs_logo\": \"praesentium\",
    \"preambles\": \"consequatur\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/tender/{id}

PATCH api/tender/{id}

URL Parameters

id integer

The ID of the tender.

Query Parameters

tender string

This is tender id.

Body Parameters

bill_id integer

title string

location string

customer string

surveyor string

date string

Must be a valid date.

document string optional

This is used for pasting a document.

client_logo string

qs_logo string

preambles string

'upload_File' => ['mimes:pdf,doc,docx'],.

Remove the specified tender from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tender/1"
);

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

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/tender/1?tender=accusantium" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Term management

Display a listing of the terms.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/terms"
);

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

let body = {
    "items": 7,
    "search": "minus"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/terms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 7,
    \"search\": \"minus\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created terms in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/terms"
);

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

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/terms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"term_type\": \"consequatur\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified terms.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/terms/4"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/terms/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified terms in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/terms/4"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/terms/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified terms from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/terms/4"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/terms/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Token management

Generate new token.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/create-token"
);

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

let body = {
    "token_name": "nzdozavyjjlgcnrqfkvlzwcpfnhirpvmbpztgycsuapeu"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/create-token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token_name\": \"nzdozavyjjlgcnrqfkvlzwcpfnhirpvmbpztgycsuapeu\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Delete specified token.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/delete-token/ut"
);

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

let body = {
    "token_name": "quas"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/delete-token/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token_name\": \"quas\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Delete specified token.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/tokens"
);

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

let body = {
    "token_name": "nihil"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/tokens" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token_name\": \"nihil\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Delete specified token.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/token/nobis"
);

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

let body = {
    "token_name": "ut"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/token/nobis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token_name\": \"ut\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Units

Display a listing of the units.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/unit"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/unit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

User management

Apis for managing User Account

Store a newly created user in storage.

This endpoint allows you to store the user resource and the address. This as well sets up the default organisation for the user.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/create"
);

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

let body = {
    "finm": "non",
    "lamn": "in",
    "phnb": "iure",
    "orgn": "numquam",
    "unmn": "voluptas",
    "email": "temporibus",
    "password": "fuga",
    "terms": false,
    "address": {
        "adds": "ea",
        "city": "quia",
        "stat": "aut",
        "poco": "quia",
        "cotr": "provident",
        "cotn": "eaque"
    },
    "zone": 16,
    "security": [
        {
            "seas": "laboriosam",
            "sequ": "architecto"
        }
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"finm\": \"non\",
    \"lamn\": \"in\",
    \"phnb\": \"iure\",
    \"orgn\": \"numquam\",
    \"unmn\": \"voluptas\",
    \"email\": \"temporibus\",
    \"password\": \"fuga\",
    \"terms\": false,
    \"address\": {
        \"adds\": \"ea\",
        \"city\": \"quia\",
        \"stat\": \"aut\",
        \"poco\": \"quia\",
        \"cotr\": \"provident\",
        \"cotn\": \"eaque\"
    },
    \"zone\": 16,
    \"security\": [
        {
            \"seas\": \"laboriosam\",
            \"sequ\": \"architecto\"
        }
    ]
}"

Example response (201, success):


{
   "success":{"message":"Resource created"},
 }

Example response (400, Bad request):


{
 "message:"The action failed"
 "errors":{
     }
 }

Example response (422, Validation error):


{
 "message:"The given data was invalid"
 "errors":{
"phnb": ["The phone number has already been taken." ],
     }
 }

Received response:

Request failed with error:

Request

POST api/create

Body Parameters

finm string

This is the first name of the user.

lamn string

This is the last name of the user.

phnb string

This is the phone number of the user.

orgn string

This is the organisation of the user.

unmn string

This is the username of the user.

email string

This is the email of the user.

password string

This is the passwordof the user.

terms boolean

Accept terms & conditions of the user.

address object

This is contains the address of the user.

address.adds string

This is contains the address of the user.

address.city string

This is contains the address of the user.

address.stat string

This is contains the address of the user.

address.poco string

This is contains the address of the user.

address.cotr string

This is contains the address of the user.

address.cotn string

This is contains the address of the user.

zone integer

This is contains the zone of the user's team.

security object[]

This is contains the security of the user.

security[].seas string

This is contains the security answer of the user.

security[].sequ string

This is contains the security question of the user.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/login"
);

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

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

let body = {
    "email": "carissa.gottlieb@example.com"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/login?unmn=facere" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"carissa.gottlieb@example.com\"
}"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 599
vary: Origin


{
    "message": "The given data was invalid.",
    "errors": {
        "unmn": [
            "The selected user name is invalid."
        ]
    }
}

Received response:

Request failed with error:

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/login"
);

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

let body = {
    "unmn": "et"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unmn\": \"et\"
}"

Example response (422):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 600
x-ratelimit-remaining: 596
vary: Origin


{
    "message": "The given data was invalid.",
    "errors": {
        "password": [
            "The account password field is required."
        ],
        "code": [
            "The code field is required."
        ],
        "recovery_code": [
            "The recovery code field is required."
        ]
    }
}

Received response:

Request failed with error:

Get a list of all the users.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/all"
);

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

let body = {
    "items": 4,
    "license": "true"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/all" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 4,
    \"license\": \"true\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Refresh the user

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/refresh"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Get subaccounts

show all the subaccounts under this account.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/sub-account"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/sub-account" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Delete the subaccount

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/sub-account/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/user/sub-account/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/update"
);

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

let body = {
    "account": [],
    "security": {
        "sequ": "velit",
        "seas": "fuga"
    },
    "address": {
        "adds": "adipisci",
        "city": "odio",
        "stat": "animi",
        "poco": "ut",
        "cotr": "odio"
    }
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account\": [],
    \"security\": {
        \"sequ\": \"velit\",
        \"seas\": \"fuga\"
    },
    \"address\": {
        \"adds\": \"adipisci\",
        \"city\": \"odio\",
        \"stat\": \"animi\",
        \"poco\": \"ut\",
        \"cotr\": \"odio\"
    }
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/user/update

Body Parameters

account object optional

This is contains the account information such as name of the user.

security object optional

This is contains the security question of the user.

security.sequ string optional

This is contains the security question of the user.

security.seas string optional

This is contains the security question of the user.

address object optional

This is contains the address of the user.

address.adds string optional

This is contains the address of the user.

address.city string optional

This is contains the address of the user.

address.stat string optional

This is contains the address of the user.

address.poco string optional

This is contains the address of the user.

address.cotr string optional

This is contains the address of the user.

Create a subaccount for the team and assign the user role in the team.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/sub-account"
);

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

let body = {
    "finm": "aut",
    "lamn": "modi",
    "phnb": "omnis",
    "orgn": "harum",
    "unmn": "corrupti",
    "email": "sed",
    "password": "assumenda",
    "role": "occaecati"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/user/sub-account" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"finm\": \"aut\",
    \"lamn\": \"modi\",
    \"phnb\": \"omnis\",
    \"orgn\": \"harum\",
    \"unmn\": \"corrupti\",
    \"email\": \"sed\",
    \"password\": \"assumenda\",
    \"role\": \"occaecati\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/user/sub-account

Body Parameters

finm string

This is the first name of the user.

lamn string

This is the last name of the user.

phnb string

This is the phone number of the user.

orgn string

This is the organisation of the user.

unmn string

This is the username of the user.

email string

This is the email of the user.

password string

This is the passwordof the user.

role string

This is the role of the user in the organisation. Example professional,admin,combo,entreprise

Display the specified user resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/user/show/illum"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/user/show/illum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Valuation Form Management

Display a listing of the valuation form.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation-form"
);

const params = {
    "project_id": "8",
    "items": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "project_id": 13,
    "items": 9
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/valuation-form?project_id=8&items=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 13,
    \"items\": 9
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created valuation form in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation-form"
);

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

let body = {
    "project_id": 19,
    "data": [
        "temporibus"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/valuation-form" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 19,
    \"data\": [
        \"temporibus\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified valuation form.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation-form/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/valuation-form/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified valuation form from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation-form/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/valuation-form/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Valuation Management

Display a cost valuations certificates for the project.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation"
);

const params = {
    "project_id": "1",
    "date": "facere",
    "items": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "project_id": 18,
    "date": "2024-04-22",
    "items": 18
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/valuation?project_id=1&date=facere&items=5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 18,
    \"date\": \"2024-04-22\",
    \"items\": 18
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/valuation

Query Parameters

project_id integer

This is the project id

date string optional

date This is the date for the valuations to be shown

items integer

This specifies how many items in the array

Body Parameters

project_id integer

date string optional

Must be a valid date in the format Y-m-d.

items integer optional

Create a valuation.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation"
);

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

let body = {
    "cost_id": 10,
    "bill_desc": [
        11
    ],
    "valuation": "sequi"
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/valuation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cost_id\": 10,
    \"bill_desc\": [
        11
    ],
    \"valuation\": \"sequi\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display valuation.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation/7-4771-1634141389"
);

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

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

let body = {
    "valuation_date": "2024-04-22",
    "certificate_id": "praesentium"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/valuation/7-4771-1634141389?certificate_id=ex" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"valuation_date\": \"2024-04-22\",
    \"certificate_id\": \"praesentium\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/valuation/{certificate_id}

URL Parameters

certificate_id string

The ID of the certificate.

Query Parameters

certificate_id string optional

This is valuation number.

Body Parameters

valuation_date string optional

Must be a valid date in the format Y-m-d.

certificate_id string optional

Remove valuation.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/valuation/7-4771-1634141389"
);

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

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/valuation/7-4771-1634141389?valuation=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Vendor management

Display a listing of the vendors.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/vendors"
);

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

let body = {
    "items": 3,
    "search": "velit"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/vendors" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 3,
    \"search\": \"velit\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created vendor in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/vendors"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/vendors" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the specified vendor.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/vendors/5"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/vendors/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified vendor in storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/vendors/5"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/vendors/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the specified vendor from storage.

requires authentication

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/vendors/5"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/vendors/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Work Tasks Management

Display a listing of the work-tasks.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/velit/work-tasks"
);

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

let body = {
    "items": 5,
    "search": "molestiae",
    "status": "molestiae"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/projects/velit/work-tasks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": 5,
    \"search\": \"molestiae\",
    \"status\": \"molestiae\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created work-tasks in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/omnis/work-tasks"
);

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

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

curl --request POST \
    "http://rapidserv.local:8000/api/projects/omnis/work-tasks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Display the work task.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/reprehenderit/work-tasks/1"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/projects/reprehenderit/work-tasks/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the work task in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/eum/work-tasks/1"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/projects/eum/work-tasks/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Remove the work task from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/et/work-tasks/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/projects/et/work-tasks/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

PUT api/projects/{project}/work-tasks

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/projects/voluptatem/work-tasks"
);

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

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

curl --request PUT \
    "http://rapidserv.local:8000/api/projects/voluptatem/work-tasks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Workplan management

Retrieve project work plans.

requires authentication

Get a list of work plans associated with a project.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-plans"
);

const params = {
    "project_id": "5",
    "items": "2",
    "order": "cum",
    "sort": "ea",
    "search": "et",
    "filter": "aliquid",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

let body = {
    "project_id": 4,
    "items": 3,
    "search": "nihil"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/work-plans?project_id=5&items=2&order=cum&sort=ea&search=et&filter=aliquid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 4,
    \"items\": 3,
    \"search\": \"nihil\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

GET api/work-plans

Query Parameters

project_id integer optional

The ID of the project.

items integer optional

The number of items to retrieve per page (greater than 0).

order string optional

The order in which to retrieve the results (asc or desc).

sort string optional

The field to use for sorting (created_at, updated_at, or id).

search string optional

optional A search term to filter work plans by.

filter string optional

optional Filter by type (template or workplan).

Body Parameters

project_id integer optional

items integer optional

order string optional

sort string optional

search string optional

filter string optional

Create a new work plan.

requires authentication

Create a new work plan with the specified parameters.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-plans"
);

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

let body = {
    "start_date": "22-04-2024",
    "finish_date": "22-04-2024",
    "data": [
        "est"
    ],
    "name": "explicabo",
    "linked_values": [
        "dolores"
    ]
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/work-plans" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"22-04-2024\",
    \"finish_date\": \"22-04-2024\",
    \"data\": [
        \"est\"
    ],
    \"name\": \"explicabo\",
    \"linked_values\": [
        \"dolores\"
    ]
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

POST api/work-plans

Body Parameters

project_id string optional

This field is required when start_date or finish_date is present.

start_date string optional

Must be a valid date in the format d-m-Y.

finish_date string optional

Must be a valid date in the format d-m-Y.

data string[] optional

name string optional

This field is required unless project_id is in null.

linked_values string[] optional

Retrieve a single work plan by ID.

requires authentication

Get the details of a specific work plan using its ID.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-plans/voluptatem"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/work-plans/voluptatem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update a work plan.

requires authentication

Update an existing work plan with the specified parameters.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-plans/3"
);

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

let body = {
    "start_date": "atque",
    "finish_date": "nisi",
    "data": [],
    "name": "veniam"
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/work-plans/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"atque\",
    \"finish_date\": \"nisi\",
    \"data\": [],
    \"name\": \"veniam\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/work-plans/{id}

PATCH api/work-plans/{id}

URL Parameters

id integer

The ID of the work plan.

work_plan string

integer The ID of the work plan to update.

Body Parameters

start_date date optional

Optional updated start date (d-m-Y format).

finish_date date optional

Optional updated finish date (d-m-Y format).

data object optional

Optional updated data for the work plan.

name string optional

Optional updated name for the work plan.

Delete a work plan.

requires authentication

Delete an existing work plan.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/work-plans/3"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/work-plans/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

tolerance

Display a listing of the resource.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tolerance"
);

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

let body = {
    "usage": "owner",
    "type": "days"
};

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/tolerance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"usage\": \"owner\",
    \"type\": \"days\"
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Store a newly created resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tolerance"
);

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

let body = {
    "usage": "owner",
    "type": "days",
    "from": "libero",
    "to": "ut",
    "limit": 317487
};

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

curl --request POST \
    "http://rapidserv.local:8000/api/tolerance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"usage\": \"owner\",
    \"type\": \"days\",
    \"from\": \"libero\",
    \"to\": \"ut\",
    \"limit\": 317487
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Update the specified resource in storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tolerance/1"
);

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

let body = {
    "usage": "contractor",
    "type": "days",
    "from": 32461778.89784851,
    "to": 10258002.061075535,
    "limit": 187738.70852595
};

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

curl --request PUT \
    "http://rapidserv.local:8000/api/tolerance/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"usage\": \"contractor\",
    \"type\": \"days\",
    \"from\": 32461778.89784851,
    \"to\": 10258002.061075535,
    \"limit\": 187738.70852595
}"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Request

PUT api/tolerance/{id}

PATCH api/tolerance/{id}

URL Parameters

id integer

The ID of the tolerance.

Body Parameters

usage string optional

Must be one of owner or contractor.

type string optional

Must be one of cost or days.

from number optional

to number optional

limit number optional

Remove the specified resource from storage.

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tolerance/1"
);

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

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

curl --request DELETE \
    "http://rapidserv.local:8000/api/tolerance/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/tolerance/refresh

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/tolerance/refresh"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/tolerance/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/risk-weights

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/risk-weights"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/risk-weights" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/risk-outcomes

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/risk-outcomes"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/risk-outcomes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/risk-data

Example request:

const url = new URL(
    "http://rapidserv.local:8000/api/risk-data"
);

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

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

curl --request GET \
    --get "http://rapidserv.local:8000/api/risk-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

Introduction

Authenticating requests

2Fa Management

Enable two factor authentication for the user.

Request

Disable two factor authentication for the user.

Request

Get the two factor authentication recovery codes for authenticated user.

Request

Generate a fresh set of two factor authentication recovery codes.

Request

Get the SVG element for the user's two factor authentication QR code.

Request

Access Management

Initiate passwordless login

Request

Body Parameters

POST api/login-passwordless

Request

Body Parameters

Base price

Display all the prices for this user.

Request

Body Parameters

Update the specified pricing item.

Request

URL Parameters

Body Parameters

Bid management

Display the specified bid.

Request

URL Parameters

Query Parameters

Submit the bid to be considered for evaluations.

Request

URL Parameters

Get all the bids of the project Filter the bids further by using the url parameters to specify status

Request

URL Parameters

Query Parameters

Get all the bids of the project Filter the bids further by using the url parameters to specify status

Request

URL Parameters

Query Parameters

Get all the bids relevant to the organisation

Request

Query Parameters

Body Parameters

Set status of a bid. status as follows 0:create, 1:received, 2:submitted, 3:negotiating, 4:closed, 5:approved, 6:award 7:accept 8:decline 9:internal

Request

URL Parameters

Query Parameters

Body Parameters

Submit the ids of bids to compare

Request

Body Parameters

Submit the ids of estimates to compare

Request

Body Parameters

Bill description management

Display a listing of the billing descriptions.

Request

Body Parameters

Store a newly bill description in storage.

Request

Body Parameters

Display the bill description.

Request

URL Parameters

Update the bill description in storage.

Request

URL Parameters

Body Parameters

Remove the bill description from storage.

Request

URL Parameters

Bill of Quantity management

Finalize the bill and take off.

Request

URL Parameters