Skip to main content

Application

info

The company has multiple applications, each of which provides a specific service for the owner's purpose.

All APIs endpoints​

[POST] /applications

[GET] /applications

[PUT] /applications/:id

[DEL] /applications/:id

Application object​

Attribute

id: string; //unique and it is an identity for the application
name: string;
describe: string;
company_id: string;
type_id: string;
setting: string;
is_default: boolean;
deleted: boolean;
createdAt: Date;
updatedAt: Date;

Example

{
  "id": "8e422fa0-1cc1-43e4-bbea-87eee3b36e7e",
  "company_id": "956865a9-b9f7-4198-87eb-10b4f0f411c9",
  "name": "gps-tracker",
  "describe": "gps-tracker for delivery",
  "type_id": "gps-tracker",
  "setting": null,
  "actorDelete": null,
  "deleted": false,
  "is_default": true,
  "created_at": "2023-01-10T09:41:07.039Z",
  "updated_at": "2023-01-10T09:41:07.039Z"
}

Create an application​

Body Request

  • name: require
  • description: optional

Request

curl --location --request POST 'https://api-v1-stg.lumyri.com/applications/' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "describe": "provide GPS for driver",
    "name": "GPS app"
}'

Response

{
  "id": "9e0c5b45-9484-4a9b-89c7-b36220b5265c",
  "company_id": "956865a9-b9f7-4198-87eb-10b4f0f411c9",
  "describe": "provide GPS for driver",
  "name": "GPS app",
  "is_default": false,
  "deleted": false,
  "type_id": null,
  "setting": null,
  "actorDelete": null,
  "createdAt": "2023-02-16T11:12:35.427Z",
  "updatedAt": "2023-02-16T11:12:35.427Z"
}

Get a list of applications​

Request

curl --location --request GET 'https://api-v1-stg.lumyri.com/applications?page=1&limit=2' \
--header 'Authorization: Bearer $ACCESS_TOKEN'

Response

{
  "total": "10",
  "current_page": "1",
  "data": [
    {
      "id": "020477e5-02fd-4e86-89fb-412ef3647ac9",
      "name": "TimeApp",
      "describe": null,
      "company_id": "956865a9-b9f7-4198-87eb-10b4f0f411c9",
      "type_id": "school-bus-tracker",
      "setting": null,
      "deleted": false,
      "created_at": "2022-12-07T08:37:20.024Z",
      "updated_at": "2022-12-07T08:37:20.024Z",
      "is_default": true,
      "actorDelete": null
    },
    {
      "id": "9e0c5b45-9484-4a9b-89c7-b36220b5265c",
      "company_id": "956865a9-b9f7-4198-87eb-10b4f0f411c9",
      "describe": "provide GPS for driver",
      "name": "GPS app",
      "is_default": false,
      "deleted": false,
      "type_id": null,
      "setting": null,
      "actorDelete": null,
      "createdAt": "2023-02-16T11:12:35.427Z",
      "updatedAt": "2023-02-16T11:12:35.427Z"
    }
  ]
}

Update an application​

Request

curl --location --request PUT 'https://api-v1-stg.lumyri.com/applications/$APP_ID' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "GPS for driver"
}'

Response

{
  "id": "9e0c5b45-9484-4a9b-89c7-b36220b5265c",
  "company_id": "956865a9-b9f7-4198-87eb-10b4f0f411c9",
  "describe": "provide GPS for driver",
  "name": "GPS for driver",
  "is_default": false,
  "deleted": false,
  "type_id": null,
  "setting": null,
  "actorDelete": null,
  "createdAt": "2023-02-16T11:12:35.427Z",
  "updatedAt": "2023-02-16T11:12:35.427Z"
}

Delete an application​

Request

curl --location --request DELETE 'https://api-v1-stg.lumyri.com/applications/$APP_ID' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \

Response

Status code: 204 no content