Main

⌘K
API-Basics
Frontu->SystemX (Periodical check + Filters)
SystemX->Frontu (Clients + Objects + Equipments)
SystemX->Frontu (Custom fields)
SystemX->Frontu (Standartized Material Remains)
SystemX->Frontu (Standartized Materials)
SystemX->Frontu (Task Request)
SystemX -> Frontu (Clients + Objects)
Task templates and task
Webhooks
Frontu API Sandbox
ClientApi/Client
ClientApi/Workspace
ClientApi/StandartizedMaterial
ClientApi/StandartizedWork
ClientApi/ResponsiblePerson
ClientApi/MaterialType
ClientApi/Place
ClientApi/Task
ClientApi/TaskRequest
ClientApi/TaskType
ClientApi/Material
ClientApi/Work
ClientApi/RouteHistory
ClientApi/TaskStatusHistory
ClientApi/Note
ClientApi/CreditStatus
ClientApi/ClientCustomField
ClientApi/TaskCustomField
ClientApi/WorkspaceCustomField
ClientApi/StandartizedWorkCustomField
ClientApi/StandartizedMaterialCustomField
ClientApi/TaskStopReason
ClientApi/File
ClientApi/File/Download
ClientApi/Image
ClientApi/Image/Download
ClientApi/EvaluationForm
ClientApi/User
ClientApi/Equipment
ClientApi/UserTaskTimes
ClientApi/Travels
ClientApi/Evaluations
ClientApi/StandartizedMaterialRemains
ClientApi/WorkspaceResponsiblePerson
Docs powered by
Archbee

SystemX->Frontu (Clients + Objects + Equipments)

11min

Clients + Objects + Equipments

Client - entity which saves all the client information.

Workspace - a particular managed facility, place, or equipment. If one site contains several facilities, each of them is registered as a separate object.

For example, you have a Client which is “UAB Client”, which has some additional data like company tax/VAT ID, Code/E.I.N number, address, city, phone number, email, etc.

For example, Workspace has some information too, like workspace name which for example are “Shop”, address, customer (which means client), serial number and etc.

For example, Equipment has some information too, like equipment name which for example are “Fridge”, Code, Equipment, Workspace, serial number and etc.

So as you can see Client is “UAB Client” and it has an object where the task can be created, for example in the workspace “Shop” and object has the equipment “Fridge”

Endpoints to use for the Clients + Objects + Equipments

First of all, before creating an object you need to create a client. So you need to use this endpoint - https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1clients/post

In this case fill all needed information like the title - client name, address - client address and etc.

In next steps you need to create object - https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1workspaces/post

And last step is to create equipment : https://developers.frontu.com/docs/tasker-api-v2/tasker_swagger.json/paths/~1client~1api~1v2~1equipments/post

Real-world data mapping examples of most common cases

First of all, you need to create Clients for example fill in this data.

JSON
|
     {
    "title": "UAB Client",
    "address": "4759  Chandler Drive",
    "city": "Joplin",
    "phone": 865744567,
    "email": "client@gmail.com",
    "companyVatCode": "12345678",
    "companyCode": "3546780",
    "deleted": false,
    "clientType": 2,
    "systemId": "CLIENT1"
   }


IMPORTANT: the title is a required field.

Then you will get a response:

JSON
|
{
   "version": 1622720578,
   "title": "UAB Client",
   "address": "4759  Chandler Drive",
   "city": "Joplin",
   "phone": "865744567",
   "email": “client@gmail.com”,
   "creditStatus": null,
   "note": null,
   "companyCode": "3546780",
   "companyVatCode": "12345678",
   "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa",
   "created": "2021-06-03T11:42:58+0000",
   "updated": "2021-06-03T11:42:58+0000",
   "deleted": false,
   "clientType": 2,
   "systemId": null,
   "customValues": null
}


In this case, you can take the client systemId or the guid and use it in the workspace.

Workspace creation example:

JSON
|
   {
    "title": "Shop",
    "client": "CLIENT1",
    "city": "Joplin",
    "systemId": "WORKSPACE1",
    "deleted": false
   }


IMPORTANT: title and the client is required fields.

Then you will get a response:

JSON
|
{
   "version": 1622721176,
   "title": "Shop",
   "serialNumber": null,
   "longitude": null,
   "latitude": null,
   "note": null,
   "address": null,
   "city": "Kaunas",
   "apartmentNumber": null,
   "signatureCode": "4d5c63d2db40db14e3f9a7334cf2c83b",
   "objectCode": "7930df975d543069dc4f74c3a78c316b",
   "client": {
       "title": "UAB Client",
       "companyCode": "3546780",
       "guid": "cc38dd65-bcdf-cd6c-b5b7-9be97e3651fa",
       "systemId": "CLIENT1"
   },
   "guid": "aee6c30b-196e-6363-4c25-f2599fe116b9",
   "created": "2021-06-03T11:52:56+0000",
   "updated": "2021-06-03T11:52:56+0000",
   "deleted": false,
   "systemId": "WORKSPACE1",
   "warrantyIndicator": null,
   "warrantyRequired": false,
   "customValues": null
}


And you can see that you have a relationship with the Workspace and Client.

Equipment creation example:

JSON
|
{
  "title": "Fridge",
  "deleted": false,
  "workspace": "WORKSPACE1",
  "serialNumber": "312o3u4i",
  "warrantyExpirationDate": "2021-01-01",
  "nextMaintenanceDate": "2020-11-01"
}


IMPORTANT: you can use the systemId for the workspace or the guid of the Frontu

Then you will get a response:

JSON
|
{
   "version": 1623061707,
   "title": "Fridge",
   "guid": "c383c988-20d3-de56-5b99-fba284bc9bac",
   "created": "2021-06-07T10:28:27+0000",
   "updated": "2021-06-07T10:28:27+0000",
   "deleted": false,
   "systemId": "EQUIPMENT1",
   "workspace": "WORKSPACE1",
   "equipmentModel": null,
   "serialNumber": "312o3u4i",
   "installDate": null,
   "warrantyExpirationDate": "2021-01-01",
   "nextMaintenanceDate": "2020-11-01",
   "note": null,
   "location": null,
   "customValues": null
}


And you can see that you have a relationship with the Workspace and Equipment.

Updated 31 Jul 2023
Did this page help you?
PREVIOUS
Frontu->SystemX (Periodical check + Filters)
NEXT
SystemX->Frontu (Custom fields)
Docs powered by
Archbee
TABLE OF CONTENTS
Clients + Objects + Equipments
Endpoints to use for the Clients + Objects + Equipments
Real-world data mapping examples of most common cases
Workspace creation example:
Equipment creation example:
Docs powered by
Archbee