Site Templates

Introduction

Site Templates is a web portal + API based capability for defining a list of Client Site Features to be auto-enabled/disabled automatically after a Client Site is created.

Once a TrackTik internal resource has enabled the Site Templates capability for a client’s TrackTik environment, a new portal setting and set of API endpoints become available.


Web Portal Settings

f17dcbef-5e29-4068-9be1-0fd020d89fa4.png

image-20240319-200153.png

API Endpoints

GET|POST|PATCH|PUT /rest/v1/site-templates

{
       "name": "Ariella test",
       "availableInSubRegions": true,
       "region": 2,
       "status": "ACTIVE",
       "id": 852
   }

POST|PATCH|PUT /clients with non null "siteTemplate": id

{
       "company": "AB Rentals",
       "customId": "854",
       "firstName": "a",
       "lastName": "b",
       "jobTitle": "",
       "primaryPhone": "",
       "secondaryPhone": "",
       "type": "CLIENT",
       "region": 2,
       "email": "",
       "closedDate": null,
       "taxLocation": null,
==>    "siteTemplate": 852,
}

GET /rest/v1/clients/{id}/features

{
           "code": "AssetManagementFeature",
           "name": "Asset Management Feature",
           "description": "Allows the creation and management of assets and the services related to them. * This is a billable feature (1 license per site activated)",
           "active": true,
           "configurationUri": "",
           "group": "PREMIUM"
       },
       {
           "code": "AssetHubFeature",
           "name": "Asset Tracking",
           "description": "Allows the creation and management of assets for the Asset Tracking feature* This is a billable feature (1 license per site activated)",
           "active": false,
           "configurationUri": "",
           "group": "PREMIUM"
       },
       {
           "code": "PatrolBrowserReportFeature",
           "name": "Onsite License",
           "description": "Create reports from the browser without the need of a mobile device.",
           "active": false,
           "configurationUri": "",
           "group": "PREMIUM"
       },
etc.

POST /site-templates/{id}/features/{Feature Code}/actions/enable
POST /site-templates/{id}/features/{Feature Code}/actions/disable


List of Feature Codes

AssetManagementFeature
AssetHubFeature
PatrolBrowserReportFeature
ShiftAppClockInFeature
GuardAppSignOutOnlyFeature
MessageBoardFeature
LoneWorkerMobileSiteFeature
SiteTaskSiteFeature
BarcodeTourFeature
GpsSiteFeature
GpsScanCheckpointFeature
PanicButtonFeature
HazardAlertFeature
PanicButtonShakeDetectionFeature
PositionPickerFeature
IDControlFeature
ResidentVisitorEnableFeature
ResidentDatabaseFeature
JobRequestForServiceFeature

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more