Info

Welcome to the generated API reference. Get Postman Collection

incidents

List all incidents

This endpoint list all your organisation's incidents.

Example request:

curl -X GET -G "http://localhost/api/incidents?page=1&status=open" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get("http://localhost/api/incidents", [
    'headers' => [
            "Authorization" => "Bearer {token}",
            "Accept" => "application/json",
        ],
    'query' => [
            "page" => "1",
            "status" => "open",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

    let params = {
            "page": "1",
            "status": "open",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

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

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/incidents

Query Parameters

Create an incident

This endpoint raises a new incident in our system. The logged in user will be used as the reporter.

Example request:

curl -X POST "http://localhost/api/incidents" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{"title":"Till 2 not rebooting","details":"Explain what is wrong with till 2 so that our agents can help you.","store_number":722,"priority":"High"}'

$client = new \GuzzleHttp\Client();
$response = $client->post("http://localhost/api/incidents", [
    'headers' => [
            "Authorization" => "Bearer {token}",
            "Accept" => "application/json",
            "Content-Type" => "application/json",
        ],
    'json' => [
            "title" => "Till 2 not rebooting",
            "details" => "Explain what is wrong with till 2 so that our agents can help you.",
            "store_number" => "722",
            "priority" => "High",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = {
    "title": "Till 2 not rebooting",
    "details": "Explain what is wrong with till 2 so that our agents can help you.",
    "store_number": 722,
    "priority": "High"
}

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

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

POST api/incidents

Body Parameters

Retrieve an incident

Retrieve a particular incident's details.

Example request:

curl -X GET -G "http://localhost/api/incidents/1" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get("http://localhost/api/incidents/1", [
    'headers' => [
            "Authorization" => "Bearer {token}",
            "Accept" => "application/json",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

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

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/incidents/{incident}

Retrieve an incident's posts

This endpoint returns a paginated list of all the posts / replies for a particular incident.

Example request:

curl -X GET -G "http://localhost/api/incidents/1/posts?page=1&sort_direction=desc&since=2019-09-02T13%3A13%3A42" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json"

$client = new \GuzzleHttp\Client();
$response = $client->get("http://localhost/api/incidents/1/posts", [
    'headers' => [
            "Authorization" => "Bearer {token}",
            "Accept" => "application/json",
        ],
    'query' => [
            "page" => "1",
            "sort_direction" => "desc",
            "since" => "2019-09-02T13:13:42",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL("http://localhost/api/incidents/1/posts");

    let params = {
            "page": "1",
            "sort_direction": "desc",
            "since": "2019-09-02T13:13:42",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

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

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/incidents/{incident}/posts

Query Parameters

Create a incident post

Creates a new post / reply to an existing incident.

Example request:

curl -X POST "http://localhost/api/incidents/1/posts" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{"details":"Everything seems to be working now. Thanks!"}'

$client = new \GuzzleHttp\Client();
$response = $client->post("http://localhost/api/incidents/1/posts", [
    'headers' => [
            "Authorization" => "Bearer {token}",
            "Accept" => "application/json",
            "Content-Type" => "application/json",
        ],
    'json' => [
            "details" => "Everything seems to be working now. Thanks!",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL("http://localhost/api/incidents/1/posts");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = {
    "details": "Everything seems to be working now. Thanks!"
}

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

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

POST api/incidents/{incident}/posts

Body Parameters

Errors

The Incidents API uses the following error codes: