OmniAccess Stellar Asset Tracking Developer API Reference (1.0.4)

Download OpenAPI specification:Download

Introduction

Preamble

Introduction

This guide describes list of API services that are provided by OmniAccess Stellar Asset Tracking portal system.

Protocol

REST interface is used for sending/receiving API messages. HTTP requests GET/POST/PUT/DELETE are used. Standard HTTP responses are used to provide requested information or error status. There is no session notion in OmniAccess Stellar Asset Tracking system, so requests could be issued according stateless model, without transport conservation between them. JSON is used as a main format for data encoding in message body part. Each request is started with the following pattern /api/{version}/{resource} where {version} is the API version number and {resource} is the name of the resource object to address.

Security considerations

Each request should contain some credential information to authenticate itself. Standard HTTP authentication with basic/bearer modes is used. JSON Web Token mechanism is used to provide authentication information. JWT has an expired timeout that is controlled by the Omniaccess Stellar Asset Tracking portal to prevent very long token usage. Also authentication with application token is used. The token must be provided in the request HTTP header, using the Authorization header. At server side, token is verified, and if it doesn’t match, 403 Not Allowed response is sent. TLS is used as a transport protocol to support message exchanges between OmniAccess Stellar Asset Tracking portal and an application.

User

Get user profile

This API is used to retrieve data associated to the logged user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user profile has been successfully fetched.",
  • "data": {
    }
}

Update user profile

This API is used to update attributes associated the logged user account.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
firstName
string

Firstname of the user.

lastName
string

Lastname of the user.

nickName
string

Nickname of the user.

jobTitle
string

Job title of the user.

workEmail
string

Work email address of the user.

personalEmail
string

Personal email address of the user.

workPhone
string

Work phone number of the user.

workMobile
string

Work mobile number of the user.

linkedInAccountUrl
string

URL to the LinkedIn user account.

facebookAccountUrl
string

URL to the Facebook user account.

twitterAccountUrl
string

URL to the Twitter user account.

instagramAccountUrl
string

URL to the Instagram user account.

lastLoginDate
string

Last login date of the user (in ISO 8601 format).

verified
boolean

Indicates if the user account has been verified by the user.

companyName
string

Company Name of the user.

preferredLanguage
string

Preferred language of the user.

street
string

Street address of the user.

city
string

City of the user.

state
string

State's address of the user.

zipCode
string

Zip code of the user.

country
string

Country address of the user.

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "jobTitle": "string",
  • "workEmail": "string",
  • "personalEmail": "string",
  • "workPhone": "string",
  • "workMobile": "string",
  • "linkedInAccountUrl": "string",
  • "facebookAccountUrl": "string",
  • "twitterAccountUrl": "string",
  • "instagramAccountUrl": "string",
  • "lastLoginDate": "string",
  • "verified": true,
  • "companyName": "string",
  • "preferredLanguage": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The user profile has been successfully updated.",
  • "data": {
    }
}

Guest

Create a Guest

This API allows to create a guest access for a given site. This guest user will receive an email containing credentials to signin.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
expiredAt
required
string

The date on which the guest account will expire. The format must be ISO 8601.

firstName
required
string

The first name of guest.

lastName
required
string

The last name of guest.

email
required
string

The email of guest.

roleId
required
string

The role of the guest.

Responses

Request samples

Content type
application/json
{
  • "expiredAt": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "roleId": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The guest has been successfully created.",
  • "data": {
    }
}

Get site guests

This API allows to fetch all guests associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guests have been successfully fetched.",
  • "data": [
    ]
}

Get a guest

This API allows to fetch one guest identified by it id.

path Parameters
siteId
required
string

This is a path param for siteId

guestId
required
string

This is a path param for guestId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest has been successfully fetched.",
  • "data": {
    }
}

Update a guest

This API allows to update one guest identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

guestId
required
string

This is a path param for guestId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
expiredAt
required
string

The date on which the guest account will expire. The format must be ISO 8601.

roleId
required
string

The role of the guest.

Responses

Request samples

Content type
application/json
{
  • "expiredAt": "string",
  • "roleId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest has been successfully updated.",
  • "data": {
    }
}

Delete a guest

This API allows to delete a guest identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

guestId
required
string

This is a path param for guestId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest has been successfully deleted.",
  • "data": {
    }
}

Reinvite a existing guest

This API allows to reinvite one guest identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

guestId
required
string

This is a path param for guestId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The guest has been successfully updated.",
  • "data": {
    }
}

Site

Create a site

This API allows to create a new site.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the site.

siteTypeId
string

The identifier of the associated default site type. Either "siteTypeId" or "siteTypeName" is required.

siteTypeName
string

The name of the site type. If "siteTypeId" is empty and "siteTypeName" has a value, the site will create with a custom site type. Either "siteTypeId" or "siteTypeName" is required.

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

Timezone of the site.

description
string

A short description of the site.

object

The location of the site, in geoJson format.

zoom
integer <int32>

Zoom value for the location of the site.

street
string

Street address of the site.

city
string

City of the site.

state
string

State of the site.

zipCode
string

Zipcode of the site.

country
string

Country of the site.

image
string

The path to the location where the site image has been uploaded.

imageName
string

Name of the imported image.

isWalkwayActivated
boolean

Specifies if the site configuration will use the walkways or not. The default value is false.

calibrationMode
string
Enum: "GATEWAYS_ONLY" "GATEWAYS_AND_BEACONS"

The calibration mode you want to use for this site. Could be either 'GATEWAYS_ONLY', in that case only the BLE Gateways will be used to calibrate your site. In the 'GATEWAYS_AND_BEACONS' mode, the gateways and the deployed Beacons will be used to calibrate your site. The default mode will be 'GATEWAYS_AND_BEACONS'.

engineMode
string
Enum: "HAN" "NEURAL_NETWORK" "ALE_ENGINE"

The engine mode of site. Default value is ALE_ENGINE. This is advanced configuration only super admin user can set it.

engineAlgo
string
Enum: "DEFAULT" "KNN_WITH_RSSI" "KNN_WITH_ATTENUATION_RSSI" "KNN_WITH_DISTANCE" "AP_RSSI"

The engine mode algorithm of site. The default value is DEFAULT. The value can be different of DEFAULT only in case where the engine mode value is HAN.

object

The IQ Messenger server of the site in Json format, or null if no IQM server.

BLEGatewaysType
string
Enum: "OMNIACCESS_STELLAR" "OMNIACCESS_OEM"

BLE gateways type of site. The default value is "OMNIACCESS_STELLAR"

siteSecret
string

Secret key of site. If the BLEGatewaysType is OMNIACCESS_STELLAR then the siteSecret is null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "siteTypeId": "string",
  • "siteTypeName": "string",
  • "timezone": "Africa/Abidjan",
  • "description": "string",
  • "location": {
    },
  • "zoom": 0,
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "country": "string",
  • "image": "string",
  • "imageName": "string",
  • "isWalkwayActivated": true,
  • "calibrationMode": "GATEWAYS_ONLY",
  • "engineMode": "HAN",
  • "engineAlgo": "DEFAULT",
  • "IQMConfiguration": {
    },
  • "BLEGatewaysType": "OMNIACCESS_STELLAR",
  • "siteSecret": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The site has been successfully created.",
  • "data": {
    }
}

Get user sites

This API allows to fetch all sites created by the authenticated user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The sites have been successfully fetched.",
  • "data": [
    ]
}

Get a site

This API allows to fetch one site identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully fetched.",
  • "data": {
    }
}

Update a site

This API allows to update one site identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the site.

siteTypeId
required
string

The identifier of the associated site type.

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "CET" "CST6CDT" "EET" "EST" "EST5EDT" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "HST" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "MET" "MST" "MST7MDT" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "WET"

Timezone of the site.

description
string

A short description of the site.

object

The location of the site, in geoJson format.

zoom
integer <int32>

Zoom value for the location of the site.

street
string

Street address of the site.

city
string

City of the site.

state
string

State of the site.

zipCode
string

Zipcode of the site.

country
string

Country of the site.

image
string

The path to the location where the site image has been uploaded.

imageName
string

Name of the imported image.

isWalkwayActivated
boolean

Specifies if the site configuration will use the walkways or not. The default value is false.

calibrationMode
string
Enum: "GATEWAYS_ONLY" "GATEWAYS_AND_BEACONS"

The calibration mode you want to use for this site. Could be either 'GATEWAYS_ONLY', in that case only the BLE Gateways will be used to calibrate your site. In the 'GATEWAYS_AND_BEACONS' mode, the gateways and the deployed Beacons will be used to calibrate your site. The default mode will be 'GATEWAYS_AND_BEACONS'.

engineMode
string
Enum: "HAN" "NEURAL_NETWORK" "ALE_ENGINE"

The engine mode of site. Default value is ALE_ENGINE. This is advanced configuration only super admin user can set it.

engineAlgo
string
Enum: "DEFAULT" "KNN_WITH_RSSI" "KNN_WITH_ATTENUATION_RSSI" "KNN_WITH_DISTANCE" "AP_RSSI"

The engine mode algorithm of site. The default value is DEFAULT. The value can be different of DEFAULT only in case where the engine mode value is HAN.

object

The IQ Messenger server of the site in Json format, or null if no IQM server.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "siteTypeId": "string",
  • "timezone": "Africa/Abidjan",
  • "description": "string",
  • "location": {
    },
  • "zoom": 0,
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "country": "string",
  • "image": "string",
  • "imageName": "string",
  • "isWalkwayActivated": true,
  • "calibrationMode": "GATEWAYS_ONLY",
  • "engineMode": "HAN",
  • "engineAlgo": "DEFAULT",
  • "IQMConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully updated.",
  • "data": {
    }
}

Delete a site

This API allows to delete one site identified by its id. All others objects linked to this site will be also deleted. (Floors, Buildings, Geofences...)

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site has been successfully deleted.",
  • "data": {
    }
}

Set production mode

This API allows to update the production mode of a site identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isInProduction
boolean

Specifies if the site is in Production mode, or not.

Responses

Request samples

Content type
application/json
{
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site production mode has been successfully updated.",
  • "data": {
    }
}

Sitetype

Create an site type

This API allows to register a new site type in a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the site type.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The site type has been successfully created.",
  • "data": {
    }
}

Get site types of site

This API allows to fetch all site types of site available in the solution.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site types have been successfully fetched.",
  • "data": [
    ]
}

Get all Default site types

This API allows to fetch all default site types available in the solution.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site types have been successfully fetched.",
  • "data": [
    ]
}

Update a site type

This API allows to update site type of site available in the solution.

path Parameters
siteId
required
string

This is a path param for siteId

siteTypeId
required
string

This is a path param for siteTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the site type.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site site type has been successfully updated.",
  • "data": {
    }
}

Delete an site type

This API allows to delete an site type identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

siteTypeId
required
string

This is a path param for siteTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset unit has been successfully deleted.",
  • "data": {
    }
}

Application

Authenticate an application

This API will try to authenticate your application and in case of sucess will return a token that is mandatory for calling other APIs.

header Parameters
Content-Type
required
string

application/json

Request Body schema: application/json
required
email
required
string

The email address of the user

password
required
string <password>

The password associated to the user account

appId
required
string

The id of an application on the platform created and associated to the user

appSecret
required
string

The secret key of the application

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "pa$$word",
  • "appId": "string",
  • "appSecret": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Y2QwNjEzYTJjNDQyMTViYmI2ZTY2MjYiLCJpYXQiOjE1NTc3NjE5NjIsImV4cCI6MTU1OTA1Nzk2Mn0.PBIINTeq7Yqs5i2jdlHhwHBqqLLJmHPC7tmERQcR3Xo",
  • "expires_in": 1296000,
  • "token_type": "Bearer"
}

Create an application

This API allows to create a new application.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the application

target
required
string
Enum: "Web application" "Admin application" "Bot application" "Desktop application" "Iot application" "Server application" "Mobile application"

The target of the application.

description
string

The description of the application.

isInProduction
boolean

Indicates if the user application is in production.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "Web application",
  • "description": "string",
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The application has been successfully created.",
  • "data": {
    }
}

Get user applications

This API allows to fetch all applications created by the authenticated user.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The applications have been successfully fetched.",
  • "data": [
    ]
}

Get a user application

This API allows to fetch one application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully fetched.",
  • "data": {
    }
}

Update a user application

This API allows to update one application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the application

target
required
string
Enum: "Web application" "Admin application" "Bot application" "Desktop application" "Iot application" "Server application" "Mobile application"

The target of the application.

description
string

The description of the application.

isInProduction
boolean

Indicates if the user application is in production.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "target": "Web application",
  • "description": "string",
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully updated.",
  • "data": {
    }
}

Delete a user application

This API allows to delete a user application identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully deleted.",
  • "data": {
    }
}

Update application state

This API update the application state identified by its id.

path Parameters
applicationId
required
string

This is a path param for applicationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isInProduction
required
boolean

Indicates if the user application is in production.

Responses

Request samples

Content type
application/json
{
  • "isInProduction": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The application has been successfully updated.",
  • "data": {
    }
}

Tagtype

[Depreciated]Get all tag types

Please note that this API is depreciated it will be removed in next version. Use the API "Get all tag types for site"

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tag types have been successfully fetched.",
  • "data": [
    ]
}

Get all tag types for site

This API allows to fetch all tag types for site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tag types have been successfully fetched.",
  • "data": [
    ]
}

Create a tag type

This API allows to create a tag type.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the tag type.

reference
required
string

The reference of the tag type.

rssiOneMeter
required
integer <int32>

The RSSI measurement value at one meter from a gateway for this kind of tag.

imageName
string

Name of the imported image.

image
string

The encoded image in base64 of the tag type.

batteryLifetime
required
integer <int32>

Battery Lifetime (in month) from the battery installation date.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reference": "string",
  • "rssiOneMeter": 0,
  • "imageName": "string",
  • "image": "string",
  • "batteryLifetime": 0
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The Tag type has been successfully created.",
  • "data": {
    }
}

Get tag type by id

This API allows to fetch get tag type by id.

path Parameters
siteId
required
string

This is a path param for siteId

tagTypeId
required
string

This is a path param for tagTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Tag types have been successfully fetched.",
  • "data": {
    }
}

Update a tag type

This API allows to update a tag type.

path Parameters
siteId
required
string

This is a path param for siteId

tagTypeId
required
string

This is a path param for tagTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the tag type.

reference
required
string

The reference of the tag type.

rssiOneMeter
required
integer <int32>

The RSSI measurement value at one meter from a gateway for this kind of tag.

imageName
string

Name of the imported image.

image
string

The encoded image in base64 of the tag type.

batteryLifetime
required
integer <int32>

Battery Lifetime (in month) from the battery installation date.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reference": "string",
  • "rssiOneMeter": 0,
  • "imageName": "string",
  • "image": "string",
  • "batteryLifetime": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The Tag type has been successfully updated.",
  • "data": {
    }
}

Delete a tag type

This API allows to delete a tag type.

path Parameters
siteId
required
string

This is a path param for siteId

tagTypeId
required
string

This is a path param for tagTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resource has been successfully deleted.",
  • "data": {
    }
}

Tag

Create a Tag

This API allows to register a new Tag in a given site. This tag can then be attached to an asset.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macAddress
required
string

The mac address of the tag.

tagTypeId
required
string

The unique identifier of the tag type.

serialNumber
required
string

The serial number of the tag.

batteryInstallationDate
string

The battery installation date of the tag (string in simplified extended ISO format, ISO 8601 as 'YYYY-MM-DDTHH:mm:ss.sssZ').

Responses

Request samples

Content type
application/json
{
  • "macAddress": "string",
  • "tagTypeId": "string",
  • "serialNumber": "string",
  • "batteryInstallationDate": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The BLE tag has been successfully created.",
  • "data": {
    }
}

Get all site tags

This API allows to fetch all tags associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE tags have been successfully fetched.",
  • "data": [
    ]
}

Mass import of Tags

This API allows to mass import a list of tags.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of tags to create.

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "BLE tags have been successfully created.",
  • "data": [
    ]
}

Get a tag

This API allows to fetch one tag identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

tagId
required
string

This is a path param for tagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE tag has been successfully fetched.",
  • "data": {
    }
}

Update a tag

This API allows to update one tag identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

tagId
required
string

This is a path param for tagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
macAddress
required
string

The mac address of the tag.

tagTypeId
required
string

The unique identifier of the tag type.

serialNumber
required
string

The serial number of the tag.

batteryInstallationDate
string

The battery installation date of the tag (string in simplified extended ISO format, ISO 8601 as 'YYYY-MM-DDTHH:mm:ss.sssZ').

Responses

Request samples

Content type
application/json
{
  • "macAddress": "string",
  • "tagTypeId": "string",
  • "serialNumber": "string",
  • "batteryInstallationDate": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE tag has been successfully updated.",
  • "data": {
    }
}

Delete a tag

This API allows to delete a tag identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

tagId
required
string

This is a path param for tagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE tag has been successfully deleted.",
  • "data": {
    }
}

Building

Create a Building

This API allows to register a new building in a given site. This building can then be attached to a floor.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the building.

description
string

The description of the building.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The building has been successfully created.",
  • "data": {
    }
}

Get all site buildings

This API allows to fetch all buildings associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The buildings have been successfully fetched.",
  • "data": [
    ]
}

Get all site buildings and floors

This API allows to fetch all buildings associated to a given site and their associated floors.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The buildings have been successfully fetched.",
  • "data": [
    ]
}

Get a building

This API allows to fetch one building identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully fetched.",
  • "data": {
    }
}

Update a building

This API allows to update one building identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the building.

description
string

The description of the building.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully updated.",
  • "data": {
    }
}

Delete a building

This API allows to delete a building identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The building has been successfully deleted.",
  • "data": {
    }
}

Floor

Create a Floor

This API allows to create a new floor in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the floor.

floorNumber
required
integer <int32>

The floor number.

map
required
string

The floor map encoded in base64.

required
object

The floor map coordinates, in geojson format. Must contain the latitude and longitude of the four floor map corners. Check response samples for expected format.

description
string

The description of the floor.

relativeAltitude
required
number <double>

The relative altitude of the floor. (in meters)

mapFileName
required
string

The floor map file name.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "floorNumber": 0,
  • "map": "string",
  • "mapCoordinates": {
    },
  • "description": "string",
  • "relativeAltitude": 0,
  • "mapFileName": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The floor has been successfully created.",
  • "data": {
    }
}

Get all floors of a building

This API allows to fetch all floors associated to a given building in a given site.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floors have been successfully fetched.",
  • "data": [
    ]
}

Get a floor

This API allows to fetch one floor identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully fetched.",
  • "data": {
    }
}

Update a floor

This API allows to update one floor identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the floor.

floorNumber
required
integer <int32>

The floor number.

map
required
string

The floor map encoded in base64.

required
object

The floor map coordinates, in geojson format. Must contain the latitude and longitude of the four floor map corners. Check response samples for expected format.

description
string

The description of the floor.

relativeAltitude
required
number <double>

The relative altitude of the floor. (in meters)

mapFileName
required
string

The floor map file name.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "floorNumber": 0,
  • "map": "string",
  • "mapCoordinates": {
    },
  • "description": "string",
  • "relativeAltitude": 0,
  • "mapFileName": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully updated.",
  • "data": {
    }
}

Delete a floor

This API allows to delete a floor identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The floor has been successfully deleted.",
  • "data": {
    }
}

Gateway

Create a BLE Gateway

This API allows to create a new gateway for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the gateway.

bleMacAddress
required
string

The mac address of BLE interface of the gateway.

wifiMacAddress
string

The mac address of Wifi interface of the gateway.

model
required
string
Enum: "OAW-AP1201" "OAW-AP1201BG" "OAW-AP1231" "OAW-AP1232" "OAW-AP1311" "OAW-AP1321" "OAW-AP1322" "OAW-AP1331" "OAW-AP1351" "OAW-AP1361" "OAW-AP1361D" "OAW-AP1362" "OAW-AP1451" "OAW-AP5xx" "OAW-AP6xx" "OAW-AP1431" "OAW-AP1411" "OAW-AP1301H"

The hardware model of the gateway.

softwareVersion
string

The software version number installed in the gateway.

groupName
string

The name of the group where the gateway is located.

ipAddress
string

The ip address of the gateway.

object

GeoJson format with type key set type "Point" and "coordinates" key set the lat/long coordinates of the gateway.

buildingId
string

The building id where the gateway will be located. Should not be given if location is not specify.

floorId
string

The floor id where the gateway will be located. Should not be given if location is not specify.

floorElevation
number <double>

The floor elevation of the gateway.

keywords
Array of strings

An array of strings containing keywords.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "bleMacAddress": "string",
  • "wifiMacAddress": "string",
  • "model": "OAW-AP1201",
  • "softwareVersion": "string",
  • "groupName": "string",
  • "ipAddress": "string",
  • "location": {
    },
  • "buildingId": "string",
  • "floorId": "string",
  • "floorElevation": 0,
  • "keywords": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The BLE gateway has been successfully created.",
  • "data": {
    }
}

Get site gateways

This API allows to fetch all gateways associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gatewayS have been successfully fetched.",
  • "data": [
    ]
}

Mass Import of Gateways

This API allows to mass import a list of gateways

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of gateways to create.

Responses

Request samples

Content type
application/json
{
  • "gateways": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "BLE gateways have been successfully created.",
  • "data": [
    ]
}

Update a gateway

This API allows to update metadata of one gateway identified by its id. Note that another API exists to set the location of a gateway.

path Parameters
siteId
required
string

This is a path param for siteId

gatewayId
required
string

This is a path param for gatewayId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the gateway.

bleMacAddress
required
string

The mac address of BLE interface of the gateway.

wifiMacAddress
string

The mac address of Wifi interface of the gateway.

model
required
string
Enum: "OAW-AP1201" "OAW-AP1201BG" "OAW-AP1231" "OAW-AP1232" "OAW-AP1311" "OAW-AP1321" "OAW-AP1322" "OAW-AP1331" "OAW-AP1351" "OAW-AP1361" "OAW-AP1361D" "OAW-AP1362" "OAW-AP1451" "OAW-AP5xx" "OAW-AP6xx" "OAW-AP1431" "OAW-AP1411" "OAW-AP1301H"

The hardware model of the gateway.

softwareVersion
string

The software version number installed in the gateway.

groupName
string

The name of the group where the gateway is located.

ipAddress
string

The ip address of the gateway.

object

GeoJson format with type key set type "Point" and "coordinates" key set the lat/long coordinates of the gateway.

buildingId
string

The building id where the gateway will be located. Should not be given if location is not specify.

floorId
string

The floor id where the gateway will be located. Should not be given if location is not specify.

floorElevation
number <double>

The floor elevation of the gateway.

keywords
Array of strings

An array of strings containing keywords.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "bleMacAddress": "string",
  • "wifiMacAddress": "string",
  • "model": "OAW-AP1201",
  • "softwareVersion": "string",
  • "groupName": "string",
  • "ipAddress": "string",
  • "location": {
    },
  • "buildingId": "string",
  • "floorId": "string",
  • "floorElevation": 0,
  • "keywords": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateway has been successfully updated.",
  • "data": {
    }
}

Get a gateway

This API allows to fetch one gateway identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

gatewayId
required
string

This is a path param for gatewayId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateway has been successfully fetched.",
  • "data": {
    }
}

Delete a gateway

This API allows to delete a gateway identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

gatewayId
required
string

This is a path param for gatewayId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateway has been successfully deleted.",
  • "data": {
    }
}

Set location of gateway

This API allows to set the location of gateway.

path Parameters
siteId
required
string

This is a path param for siteId

gatewayId
required
string

This is a path param for gatewayId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
id
required
string

The id of the gateway.

buildingId
required
string

The building id where the gateway has been located.

floorId
required
string

The floor id where the gateway has been located.

required
object

GeoJson format with type key set type "Point" and "coordinates" key set the lat/long coordinates of the gateway.

floorElevation
number <double>

The floor elevation where the gateway is located.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "buildingId": "string",
  • "floorId": "string",
  • "location": {
    },
  • "floorElevation": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateway has been successfully updated.",
  • "data": {
    }
}

Get building gateways

This API allows to fetch all gateways located in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateways have been successfully fetched.",
  • "data": [
    ]
}

Get floor gateways

This API allows to fetch all gateways located in a given floor of a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The BLE gateways have been successfully fetched.",
  • "data": [
    ]
}

Indoorarea

Create an indoor area

This API allows to create a new indoor area for a given floor.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the indoor area.

required
object

The lat/long coordinates of the area polygon, in geojson format.

area
required
number <double>

The size of the indoor area.

areaUnit
required
string
Enum: "squareMeters" "squareFeets"

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

color
string

The color chosen for displaying the given area. The default value of color is 3388ff.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "polygon": {
    },
  • "area": 0,
  • "areaUnit": "squareMeters",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The indoor area has been successfully created.",
  • "data": {
    }
}

Get floor indoor areas

This API allows to fetch all indoor areas located in a given floor of a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor areas have been successfully fetched.",
  • "data": [
    ]
}

Get site indoor areas

This API allows to fetch all indoor areas associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor areas have been successfully fetched.",
  • "data": [
    ]
}

Get building indoor areas

This API allows to fetch all indoor areas located in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor areas have been successfully fetched.",
  • "data": [
    ]
}

Get an indoor area

This API allows to fetch one indoor area identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

indoorAreaId
required
string

This is a path param for indoorAreaId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor area has been successfully fetched.",
  • "data": {
    }
}

Delete an indoor area

This API allows to delete a indoor area identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

indoorAreaId
required
string

This is a path param for indoorAreaId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor area has been successfully deleted.",
  • "data": {
    }
}

Update an indoor area

This API allows to update one indoor area identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

indoorAreaId
required
string

This is a path param for indoorAreaId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the indoor area.

required
object

The lat/long coordinates of the area polygon, in geojson format.

area
required
number <double>

The size of the indoor area.

areaUnit
required
string
Enum: "squareMeters" "squareFeets"

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

color
string

The color chosen for displaying the given area. The default value of color is 3388ff.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "polygon": {
    },
  • "area": 0,
  • "areaUnit": "squareMeters",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor area has been successfully updated.",
  • "data": {
    }
}

Update an indoor area polygon

This API allows to update the polygon of one indoor area identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

indoorAreaId
required
string

This is a path param for indoorAreaId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the indoor area.

required
object

The lat/long coordinates of the area polygon, in geojson format.

area
required
number <double>

The size of the indoor area.

areaUnit
required
string
Enum: "squareMeters" "squareFeets"

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

color
string

The color chosen for displaying the given area. The default value of color is 3388ff.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "polygon": {
    },
  • "area": 0,
  • "areaUnit": "squareMeters",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The indoor area has been successfully updated.",
  • "data": {
    }
}

Metric

Get the number of gateways per site

This API allows to get statistics of gateways per site identified by id

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of BLE gateways have been successfully fetched.",
  • "data": 5
}

Get the number of tags per site

This API allows to get statistics of tags per site identified by id

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of BLE tags have been successfully fetched.",
  • "data": 7
}

Get the number of assets per site

This API allows to get statistics of assets per site identified by id

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of assets have been successfully fetched.",
  • "data": 12
}

Get the people assets inside the geofence now

This API allows to get the people assets who are inside a geofence

path Parameters
siteId
required
string

This is a path param for siteId

geofenceId
required
string

This is a path param for geofenceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets have been successfully fetched.",
  • "data": [
    ]
}

Get the number of auto calibration tags per site

This API allows to get statistics of autocalibration beacons per site

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of BLE autocalibration tags have been successfully fetched.",
  • "data": 12
}

Get the number of assets per criteria

This API allows to get statistics of assets filtered by given criteria specified by the 'filterBy' query-string argument.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
filterBy
required
string

The filter to apply. Could be unit, tagType, availability, batteryLevel or category.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The number of assets have been successfully fetched.",
  • "data": {
    }
}

Get Areas Density (Assets)

This API allows to get the number of assets present in a geofence per time window.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
timeWindow
required
string

The duration considered when processing metrics. Accepted values are month, week, day, daytime, hour.

startPoint
string

The start date point in (UTC) ISO format: 2019-10-12T22:11:13Z

areaType
string

Type of area where density is computed. Allowed values are: site, building, floor, geofence. Default value is site.

areaId
string

Only if there is areaType parameter. Specify a building id, floor id or geofence id according the value of areaType.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The area density of assets has been successfully fetched.",
  • "data": {
    }
}

Get Areas Density (People)

This API allows to get the number of people asset (patient, visitor or staff, ...) present in a given area (site, building, floor, geofence) per time window.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
timeWindow
required
string

The duration considered when processing metrics. Accepted values are month, week, day, daytime, hour

startPoint
string

The start date point in (UTC) ISO format: 2019-10-12T22:11:13Z

category
required
string

Category of people. Allowed values are: patient, staff, visitor

areaType
string

Type of area where density is computed. Allowed values are: site, building, floor, geofence. Default value is site.

areaId
string

Only if there is areaType parameter. Specify a building id, floor id or geofence id according the value of areaType.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The area density of assets has been successfully fetched.",
  • "data": {
    }
}

Latest known locations of assets

This API allows to get the latest known locations of a list of assets during a given time window.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
timeWindow
required
string

The duration considered when processing history metrics. Accepted values are 15, 30, 45 or 60 minutes.

macAddresses
required
string

comma-separated list of asset mac adresses in standard format: 01:23:89:AC:B5:FD.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The latest known locations of assets are succesfully fetched",
  • "data": {
    }
}

People time spent in site geofences

This API returns the time spent by a specific person or category of people in each area in which they have been viewed, within 12 hours maximum time window.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
peopleId
required
string

comma-separated list of people assets or people asset category ids or 'all'(if its concerns all site people assets).

timeWindow
required
string

The duration considered when processing history metrics. Accepted values are 15, 30, 45 or 60 minutes.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The area density of assets has been successfully fetched.",
  • "data": [
    ]
}

Geofence

Create a Geofence

This API allows to create a geofence for a given floor.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the geofence.

required
object

The lat/long coordinates of the area polygon, in geojson format.

area
required
number <double>

The size of the geofence.

areaUnit
required
string

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

color
string

The color chosen for displaying the given area. The default value of color is 3388ff.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "polygon": {
    },
  • "area": 0,
  • "areaUnit": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The geofence has been successfully created.",
  • "data": {
    }
}

Get floor geofences

This API allows to fetch all geofences located in a given floor of a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofences have been successfully fetched.",
  • "data": [
    ]
}

Get site geofences

This API allows to fetch all geofences associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofences have been successfully fetched.",
  • "data": [
    ]
}

Get building geofences

This API allows to fetch all geofences located in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofences have been successfully fetched.",
  • "data": [
    ]
}

Get a geofence

This API allows to fetch one geofence identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

geofenceId
required
string

This is a path param for geofenceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence has been successfully fetched.",
  • "data": {
    }
}

Delete a geofence

This API allows to delete a geofence identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

geofenceId
required
string

This is a path param for geofenceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence has been successfully deleted.",
  • "data": {
    }
}

Update a geofence

This API allows to update one geofence identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

geofenceId
required
string

This is a path param for geofenceId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the geofence.

required
object

The lat/long coordinates of the area polygon, in geojson format.

area
required
number <double>

The size of the geofence.

areaUnit
required
string

The unit of the given area. Must be one of 'squareMeters', 'squareFeets'.

color
string

The color chosen for displaying the given area. The default value of color is 3388ff.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "polygon": {
    },
  • "area": 0,
  • "areaUnit": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence has been successfully updated.",
  • "data": {
    }
}

Autocalibrationtag

Create an autocalibration beacon

This API allows to create a new autocalibration beacon for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the autocalibration beacon.

macAddress
required
string

The mac address of the autocalibration beacon.

tagTypeId
required
string

The unique identifier of the tag type.

batteryInstallationDate
string

The date where the battery has been installed. The format must be ISO 8601. This will be used to compute the battery lifetime.

buildingId
string

The building id where the autocalibration beacon will be located. Should not be given if location is not specify.

floorId
string

The floor id where the autocalibration beacon will be located. Should not be given if location is not specify.

object

GeoJson format with type key set type "Point" and "coordinates" key set the lat/long coordinates of the autocalibrating beacon.

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "macAddress": "string",
  • "tagTypeId": "string",
  • "batteryInstallationDate": "string",
  • "buildingId": "string",
  • "floorId": "string",
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The autocalibration tag has been successfully created.",
  • "data": {
    }
}

Get site autocalibration beacons

This API allows to fetch all autocalibration beacons associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tags have been successfully fetched.",
  • "data": [
    ]
}

Delete multiple autocalibration beacons

This API allows to delete multiple autocalibration beacons identified by their ids.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
autoCalibrationTagIds
required
Array of strings

An array of autocalibration beacon ids to delete.

Responses

Request samples

Content type
application/json
{
  • "autoCalibrationTagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tags have been successfully deleted.",
  • "data": {
    }
}

Mass import of autocalibration beacons

This API allows to mass import a list of autocalibration beacons.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
Array of objects

An array of autocalibration beacons to create.

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The autocalibration tags have been successfully created.",
  • "data": [
    ]
}

Get building autocalibration beacons

This API allows to fetch all autocalibration beacons located in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tags have been successfully fetched.",
  • "data": [
    ]
}

Get floor autocalibration beacons

This API allows to fetch all autocalibration beacons located in a given floor of a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tags have been successfully fetched.",
  • "data": [
    ]
}

Get an autocalibration beacon

This API allows to fetch one autocalibration beacon identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

autoCalibrationTagId
required
string

This is a path param for autoCalibrationTagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tags has been successfully fetched.",
  • "data": {
    }
}

Update an autocalibration beacon

This API allows to update metadata of one autocalibration beacon identified by its id. Note that another API exists to set the location of an autocalibration beacon.

path Parameters
siteId
required
string

This is a path param for siteId

autoCalibrationTagId
required
string

This is a path param for autoCalibrationTagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
serialNumber
required
string

The serial number of the autocalibration beacon.

macAddress
required
string

The mac address of the autocalibration beacon.

tagTypeId
required
string

The unique identifier of the tag type.

batteryInstallationDate
string

The date where the battery has been installed. The format must be ISO 8601. This will be used to compute the battery lifetime.

buildingId
string

The building id where the autocalibration beacon will be located. Should not be given if location is not specify.

floorId
string

The floor id where the autocalibration beacon will be located. Should not be given if location is not specify.

object

GeoJson format with type key set type "Point" and "coordinates" key set the lat/long coordinates of the autocalibrating beacon.

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "string",
  • "macAddress": "string",
  • "tagTypeId": "string",
  • "batteryInstallationDate": "string",
  • "buildingId": "string",
  • "floorId": "string",
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The autocalibration tag has been successfully created.",
  • "data": {
    }
}

Delete an autocalibration beacon

This API allows to delete an autocalibration beacon identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

autoCalibrationTagId
required
string

This is a path param for autoCalibrationTagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tag has been successfully deleted.",
  • "data": {
    }
}

Set location of autocalibration beacon

This API allows to set the location of autocalibration beacon.

path Parameters
siteId
required
string

This is a path param for siteId

autoCalibrationTagId
required
string

This is a path param for autoCalibrationTagId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
required
object

A JSON objects containing autocalibration beacon location.

Responses

Request samples

Content type
application/json
{
  • "autoCalibrationTag": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The autocalibration tag has been successfully updated.",
  • "data": {
    }
}

Assetcategory

Create an Asset Category

This API allows to create a new asset category with its subcategories and its custom fields for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the Asset Category. The name cannot be changed after creation.

iconSize
string
Enum: "SIZE_SMALL" "SIZE_LARGE"

The size of the icon.

iconName
string

The name of the icon associated to the Asset Category (as patients.png).

iconImg
string

The encoded image in base64 of the asset category.

isPeopleCategory
boolean

This field indicates if the category is a people category or not. Default value is false and it cannot be changed after creation.

Array of objects

An array of JSON objects containing all subcategories of the asset category

Array of objects

An array of JSON objects containing all custom fields of the asset category

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "iconSize": "SIZE_SMALL",
  • "iconName": "string",
  • "iconImg": "string",
  • "isPeopleCategory": true,
  • "subcategories": [
    ],
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The asset category has been successfully created.",
  • "data": {
    }
}

Get site asset categories

This API allows to fetch all asset categories associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset categories have been successfully fetched.",
  • "data": [
    ]
}

Get an asset category

This API allows to fetch one asset category identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetCategoryId
required
string

This is a path param for assetCategoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset category has been successfully fetched.",
  • "data": {
    }
}

Update an asset category

This API allows to update one asset category identified by its id. Note that the name and isPeopleCategory values cannot be changed after creation.

path Parameters
siteId
required
string

This is a path param for siteId

assetCategoryId
required
string

This is a path param for assetCategoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
iconSize
string
Enum: "SIZE_SMALL" "SIZE_LARGE"

The size of the icon.

iconName
string

The name of the icon associated to the Asset Category (as patients.png).

iconImg
string

The encoded image in base64 of the asset category.

Array of objects

An array of JSON objects containing all subcategories of the asset category

Array of objects

An array of JSON objects containing all custom fields of the asset category

Responses

Request samples

Content type
application/json
{
  • "iconSize": "SIZE_SMALL",
  • "iconName": "string",
  • "iconImg": "string",
  • "subcategories": [
    ],
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset category has been successfully updated.",
  • "data": {
    }
}

Delete an asset category

This API allows to delete an asset category identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetCategoryId
required
string

This is a path param for assetCategoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset category has been successfully deleted.",
  • "data": {
    }
}

Asset

Create an asset

This API allows to register a new asset in a given site. This asset can then be attached to a floor.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the asset.

assetUnitId
required
string

The identifer of the associated asset unit.

assetCategoryId
required
string

The identifier of the associated asset category.

imageName
string

The name of the image that has been uploaded and associated to the asset (as myImage.png).

image
string

The path to the location where the asset image has been uploaded.

assetSubcategoryId
string

The identifier of the associated asset subcategory.

tagId
string

The unique identifier of the associated tag.

isEnabled
boolean

The status of asset, it can be set when tag is associated to asset. The default value is false.

Array of objects

An array of JSON objects containing custom field id and value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assetUnitId": "string",
  • "assetCategoryId": "string",
  • "imageName": "string",
  • "image": "string",
  • "assetSubcategoryId": "string",
  • "tagId": "string",
  • "isEnabled": true,
  • "customfields": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The asset has been successfully created.",
  • "data": {
    }
}

Get all site assets

This API allows to fetch all assets associated to a given site. This API can cause performance problems if the site has a lot of assets. You can use in this case the API 'Get assets of site'.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets have been successfully fetched.",
  • "data": [
    ]
}

Get all assets of a category

This API allows to fetch all assets associated to a given category.

path Parameters
siteId
required
string

This is a path param for siteId

assetCategoryId
required
string

This is a path param for assetCategoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets have been successfully fetched.",
  • "data": [
    ]
}

Get an asset

This API allows to fetch one asset identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset has been successfully fetched.",
  • "data": {
    }
}

Update an asset

This API allows to update one asset identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the asset.

assetUnitId
required
string

The identifer of the associated asset unit.

assetCategoryId
required
string

The identifier of the associated asset category.

imageName
string

The name of the image that has been uploaded and associated to the asset (as myImage.png).

image
string

The path to the location where the asset image has been uploaded.

assetSubcategoryId
string

The identifier of the associated asset subcategory.

tagId
string

The unique identifier of the associated tag.

isEnabled
boolean

The status of asset, it can be set when tag is associated to asset. The default value is false.

Array of objects

An array of JSON objects containing custom field id and value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assetUnitId": "string",
  • "assetCategoryId": "string",
  • "imageName": "string",
  • "image": "string",
  • "assetSubcategoryId": "string",
  • "tagId": "string",
  • "isEnabled": true,
  • "customfields": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset has been successfully updated.",
  • "data": {
    }
}

Delete an asset

This API allows to delete an asset identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset has been successfully deleted.",
  • "data": {
    }
}

Update an asset status

This API allows to update the status of the asset. While the asset status will not be enabled, no location will be generated.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isEnabled
required
boolean

The status of the asset.

Responses

Request samples

Content type
application/json
{
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset status has been successfully updated.",
  • "data": {
    }
}

Set a custom field value to an asset

This API allows to set a custom field value to an asset identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

customFieldId
required
string

This is a path param for customFieldId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
customFieldValue
string

The value associated to the custom field of the asset

Responses

Request samples

Content type
application/json
{
  • "customFieldValue": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset has been successfully updated.",
  • "data": {
    }
}

Get custom fields of an asset by id

This API allows to fetch one asset custom fields array identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetId
required
string

This is a path param for assetId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset customfields have been successfully fetched.",
  • "data": [
    ]
}

Update the category of multiple assets

This API allows to update the category of multiple assets.

path Parameters
siteId
required
string

This is a path param for siteId

categoryId
required
string

This is a path param for categoryId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
assetIds
required
Array of strings

An array ids of the asset.

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets category have been successfully updated.",
  • "data": [
    ]
}

Get assets of site

This API allows to fetch all assets associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
offset
integer

This is a query param to indicate the number of assets to skip. The default value is 0.

limit
integer

This is a query param to indicate the maximun numbers of assets to return. The default value will be -1 for all assets.

filters
object

Filters are applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: unitName. If no filter is applied, send an empty JSON or null. If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'unitName ', 'assetName ', 'categoryName ', 'subcategoryName '. ex: filter with object: {"assetName": "asset1"}

populate
string

The populate allows getting the element associated with assets. ex: tag, assetcategory, assetsubcategory, customfields. If the user send a value is "*" then get all elements associated with assets. If no populate is applied, send an empty JSON or null.

sort
string

The sort order. Sorting to apply to the updatedAt attribute. The default order will be DESC.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets have been successfully fetched.",
  • "data": {
    }
}

Assettracking

Fetch assets on Floor

This API allows to get all assets seen on a given floor. An array of filters can be provided to refine the search.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Fetch assets on Site

This API allows to get all assets seen on a given site. An array of filters can be provided to refine the search.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Fetch tags on Floor

This API allows to get all tags seen on a given floor. An array of filters can be provided to refine the search.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Fetch tags on Site

This API allows to get all tags seen on a given site. An array of filters can be provided to refine the search.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The resources have been successfully fetched.",
  • "data": [
    ]
}

Get historical location data for the floor's assets

The purpose of this API is to let the user accessing the historical location of assets inside specific floor during period.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

query Parameters
startDate
required
integer

This is a query param for start date in milliseconds timestamp format

endDate
required
integer

This is a query param for end date in milliseconds timestamp format

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets history have been successfully fetched.",
  • "data": [
    ]
}

Get assets positions for all user sites

This API allows to get assets positions for all user sites. An array of filters can be provided to refine the search.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The assets position have been successfully fetched.",
  • "data": [
    ]
}

Get tags for all user sites

This API allows to get tags for all user sites. An array of filters can be provided to refine the search.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
object

An array of filters can be provided to refine the search.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The tags position have been successfully fetched.",
  • "data": [
    ]
}

Role

Create a new role

This API allows to create a new role for specific site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The unique name of the role.

required
Array of objects

The differents options of ressources which the role can has access.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The role have been successfully created.",
  • "data": {
    }
}

Get site roles

This API allows to fetch all roles associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The roles have been sucessfully fetched.",
  • "data": [
    ]
}

Get a role

This API allows to fetch one role identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

roleId
required
string

This is a path param for roleId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role has been successfully fetched.",
  • "data": {
    }
}

Update a role

This API allows to update a role for identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

roleId
required
string

This is a path param for roleId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The unique name of the role.

required
Array of objects

The differents options of ressources which the role can has access.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role has been successfully updated.",
  • "data": {
    }
}

Delete a role

This API allows to delete one role identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

roleId
required
string

This is a path param for roleId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The role has been sucessfully deleted.",
  • "data": {
    }
}

Walltype

Get all wall types

This API allows to fetch all wall types available in the solution. (The wall type id is required to create a new wall)

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Wall types have been successfully fetched.",
  • "data": [
    ]
}

Wall

Create a wall

This API allows to create a new wall for a given floor.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

required
object

The lat/long coordinates of the line, in geojson format.

distance
required
integer <int32>

The distance value of the wall.

distanceUnit
required
string
Enum: "meters" "feets"

The distance unit.

wallTypeId
required
string

A unique Id of a walltype identifying the material of the wall.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geometry": {
    },
  • "distance": 0,
  • "distanceUnit": "meters",
  • "wallTypeId": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The wall has been successfully created.",
  • "data": {
    }
}

Get floor walls

This API allows to fetch all walls located in a given floor of a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Get site walls

This API allows to fetch all walls associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Get building walls

This API allows to fetch all walls located in a given building.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The walls have been successfully fetched.",
  • "data": [
    ]
}

Get a wall

This API allows to fetch one wall identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully fetched.",
  • "data": {
    }
}

Delete a wall

This API allows to delete a wall identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully deleted.",
  • "data": {
    }
}

Update a wall

This API allows to update one wall identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

required
object

The lat/long coordinates of the line, in geojson format.

distance
required
integer <int32>

The distance value of the wall.

distanceUnit
required
string
Enum: "meters" "feets"

The distance unit.

wallTypeId
required
string

A unique Id of a walltype identifying the material of the wall.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geometry": {
    },
  • "distance": 0,
  • "distanceUnit": "meters",
  • "wallTypeId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully updated.",
  • "data": {
    }
}

Update a wall geometry

This API allows to update the geometry of one wall identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

buildingId
required
string

This is a path param for buildingId

floorId
required
string

This is a path param for floorId

wallId
required
string

This is a path param for wallId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the wall.

required
object

The lat/long coordinates of the line, in geojson format.

distance
required
integer <int32>

The distance value of the wall.

distanceUnit
required
string
Enum: "meters" "feets"

The distance unit.

wallTypeId
required
string

A unique Id of a walltype identifying the material of the wall.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geometry": {
    },
  • "distance": 0,
  • "distanceUnit": "meters",
  • "wallTypeId": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The wall has been successfully updated.",
  • "data": {
    }
}

Geonotification

Create a Geo-notification

This API allows to create a geo-notification for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of geonotification.

triggerCondition
required
string
Enum: "IN" "OUT" "THRESHOLD"

The trigger condition of geonotification. Allowed values are IN or OUT or THRESHOLD.

assetThreshold
integer <int32>

The asset(s) threshold of geonotification's geofence. This is required when the triggerCondition is THRESHOLD else the default value will be 1.

geofenceId
required
string

The geofence of geonotification.

startTime
required
string

The start date and time of geonotification. Set null if the geonotification is not trigger in a specific period.

endTime
required
string

The end date and time of geonotification. Set null if the geonotification is not trigger in a specific period.

severity
required
string

The severity type of geonotification. Allowed values are HIGH or LOW.

isActive
required
boolean

The state of geonotification.

isTriggerAll
required
boolean

Define if the notification concerns all assets of site.

isAllUsers
required
boolean

Define if all users of site will be notified.

required
Array of objects

An array of notification types which associated to geonotification.

assets
required
Array of strings

An array of assets id which associated to geonotification. Must be empty array when isTriggerAll is true.

assetCategories
required
Array of strings

An array of assets categories id which associated to geonotification. Must be empty array when isTriggerAll is true.

roles
required
Array of strings

An array of roles id which associated to geonotification. Must be empty array when isAllUsers is true.

users
required
Array of strings

An array of users id which associated to geonotification. Must be empty array when isAllUsers is true.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "triggerCondition": "IN",
  • "assetThreshold": 0,
  • "geofenceId": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "severity": "string",
  • "isActive": true,
  • "isTriggerAll": true,
  • "isAllUsers": true,
  • "notificationTypes": [
    ],
  • "assets": [
    ],
  • "assetCategories": [
    ],
  • "roles": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The geofence notification has been successfully created.",
  • "data": {
    }
}

Get site geo-notifications

This API allows to fetch all geo-notifications associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofences notifications have been successfully fetched.",
  • "data": [
    ]
}

Get a geo-notification

This API allows to fetch one geo-notification identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

notificationId
required
string

This is a path param for notificationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence notification has been successfully fetched.",
  • "data": {
    }
}

Update a geo-notification

This API allows to update one geo-notification identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

notificationId
required
string

This is a path param for notificationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of geonotification.

triggerCondition
required
string
Enum: "IN" "OUT" "THRESHOLD"

The trigger condition of geonotification. Allowed values are IN or OUT or THRESHOLD.

assetThreshold
integer <int32>

The asset(s) threshold of geonotification's geofence. This is required when the triggerCondition is THRESHOLD else the default value will be 1.

geofenceId
required
string

The geofence of geonotification.

startTime
required
string

The start date and time of geonotification. Set null if the geonotification is not trigger in a specific period.

endTime
required
string

The end date and time of geonotification. Set null if the geonotification is not trigger in a specific period.

severity
required
string

The severity type of geonotification. Allowed values are HIGH or LOW.

isActive
required
boolean

The state of geonotification.

isTriggerAll
required
boolean

Define if the notification concerns all assets of site.

isAllUsers
required
boolean

Define if all users of site will be notified.

required
Array of objects

An array of notification types which associated to geonotification.

assets
required
Array of strings

An array of assets id which associated to geonotification. Must be empty array when isTriggerAll is true.

assetCategories
required
Array of strings

An array of assets categories id which associated to geonotification. Must be empty array when isTriggerAll is true.

roles
required
Array of strings

An array of roles id which associated to geonotification. Must be empty array when isAllUsers is true.

users
required
Array of strings

An array of users id which associated to geonotification. Must be empty array when isAllUsers is true.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "triggerCondition": "IN",
  • "assetThreshold": 0,
  • "geofenceId": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "severity": "string",
  • "isActive": true,
  • "isTriggerAll": true,
  • "isAllUsers": true,
  • "notificationTypes": [
    ],
  • "assets": [
    ],
  • "assetCategories": [
    ],
  • "roles": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence notification has been successfully updated.",
  • "data": {
    }
}

Delete a geo-notification

This API allows to delete a geo-notification identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

notificationId
required
string

This is a path param for notificationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence notification has been successfully deleted.",
  • "data": {
    }
}

Update a geo-notification status

This API allows to update the geo-notification status of one geonotification identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

notificationId
required
string

This is a path param for notificationId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isActive
required
boolean

Boolean indicating the status of a geonotification.

Responses

Request samples

Content type
application/json
{
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geofence notification has been successfully updated.",
  • "data": {
    }
}

Notificationtype

Get all notifications types

This API allows to fetch all notifications types.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The notification types have been successfully fetched.",
  • "data": [
    ]
}

Pushbuttonalert

Create a push button alert

This API allows to create a push button alert for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of alert.

triggerCondition
required
string
Value: "PRESS"

The trigger condition of alert. Allowed value is PRESS.

pushEventTypeId
required
string

The id of alert's event type.

startTime
required
string

The start date and time of alert. Set null if the push button alert is not trigger in a specific period.

endTime
required
string

The end date and time of alert. Set null if the push button alert is not trigger in a specific period.

severity
required
string

The severity type of alert. Allowed values are HIGH or LOW.

isActive
required
boolean

The state of alert.

isTriggerNone
required
boolean

Define if the alert concerns none asset, asset category, asset subcategory of site.

isAllUsers
required
boolean

Define if the notification will be sent to all users of site.

required
Array of objects

An array of notification types which associated to alert.

assets
required
Array of strings

An array of assets id which will be associated to alert. Must be empty array when isTriggerNone is true.

assetCategories
required
Array of strings

An array of assets categories id which will be associated to alert. Must be empty array when isTriggerNone is true.

assetSubcategories
required
Array of strings

An array of assets subcategories id which will be associated to alert. Must be empty array when isTriggerNone is true.

roles
required
Array of strings

An array of roles id which will be associated to alert. Must be empty array when isAllUsers is true.

users
required
Array of strings

An array of users id which will be associated to alert. Must be empty array when isAllUsers is true.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "triggerCondition": "PRESS",
  • "pushEventTypeId": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "severity": "string",
  • "isActive": true,
  • "isTriggerNone": true,
  • "isAllUsers": true,
  • "pushButtonNotificationTypes": [
    ],
  • "assets": [
    ],
  • "assetCategories": [
    ],
  • "assetSubcategories": [
    ],
  • "roles": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The push button alert has been successfully created.",
  • "data": {
    }
}

Get site push button alerts

This API allows to fetch all push button alerts associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button alerts have been successfully fetched.",
  • "data": [
    ]
}

Get a push button alert

This API allows to fetch one push button alert identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushButtonAlertId
required
string

This is a path param for pushButtonAlertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button has been successfully fetched.",
  • "data": {
    }
}

Update a push button alert

This API allows to update one push button alert identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushButtonAlertId
required
string

This is a path param for pushButtonAlertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of alert.

triggerCondition
required
string
Value: "PRESS"

The trigger condition of alert. Allowed value is PRESS.

pushEventTypeId
required
string

The id of alert's event type.

startTime
required
string

The start date and time of alert. Set null if the push button alert is not trigger in a specific period.

endTime
required
string

The end date and time of alert. Set null if the push button alert is not trigger in a specific period.

severity
required
string

The severity type of alert. Allowed values are HIGH or LOW.

isActive
required
boolean

The state of alert.

isTriggerNone
required
boolean

Define if the alert concerns none asset, asset category, asset subcategory of site.

isAllUsers
required
boolean

Define if the notification will be sent to all users of site.

required
Array of objects

An array of notification types which associated to alert.

assets
required
Array of strings

An array of assets id which will be associated to alert. Must be empty array when isTriggerNone is true.

assetCategories
required
Array of strings

An array of assets categories id which will be associated to alert. Must be empty array when isTriggerNone is true.

assetSubcategories
required
Array of strings

An array of assets subcategories id which will be associated to alert. Must be empty array when isTriggerNone is true.

roles
required
Array of strings

An array of roles id which will be associated to alert. Must be empty array when isAllUsers is true.

users
required
Array of strings

An array of users id which will be associated to alert. Must be empty array when isAllUsers is true.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "triggerCondition": "PRESS",
  • "pushEventTypeId": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "severity": "string",
  • "isActive": true,
  • "isTriggerNone": true,
  • "isAllUsers": true,
  • "pushButtonNotificationTypes": [
    ],
  • "assets": [
    ],
  • "assetCategories": [
    ],
  • "assetSubcategories": [
    ],
  • "roles": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button has been successfully updated.",
  • "data": {
    }
}

Delete a push button alert

This API allows to delete a push button alert identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushButtonAlertId
required
string

This is a path param for pushButtonAlertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button has been successfully deleted.",
  • "data": {
    }
}

Update a push button alert status

This API allows to update the status of one push button alert identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushButtonAlertId
required
string

This is a path param for pushButtonAlertId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isActive
required
boolean

Boolean indicating the new status of alert.

Responses

Request samples

Content type
application/json
{
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button has been successfully updated.",
  • "data": {
    }
}

Pushbuttonnotificationtype

Get all push button notification types

This API allows to fetch all push button notification types.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push button notification types have been successfully fetched.",
  • "data": [
    ]
}

Pusheventtype

Create a push event type

This API allows to create a push event type for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of push event type. (The name must be unique for given site)

isDefault
required
boolean

Define if the push event type is default. The acceptable value is false.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The push event type has been successfully created.",
  • "data": {
    }
}

Get site push event types

This API allows to fetch all push event types associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push event types have been successfully fetched.",
  • "data": [
    ]
}

Get a push event type

This API allows to fetch one push event type identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushEventTypeId
required
string

This is a path param for pushEventTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push event type has been successfully fetched.",
  • "data": {
    }
}

Update a push event type

This API allows to update one push event type identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushEventTypeId
required
string

This is a path param for pushEventTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of push event type. (The name must be unique for given site)

isDefault
required
boolean

Define if the push event type is default. The acceptable value is false.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push event type has been successfully updated.",
  • "data": {
    }
}

Delete a push event type

This API allows to delete a push event type identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

pushEventTypeId
required
string

This is a path param for pushEventTypeId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push event type has been successfully deleted.",
  • "data": {
    }
}

Alarm

Get geo-notification alarms and push button alarms of user sites

This API allows to fetch all geo-notification alarms and push button alarms that have been generated for all user sites.

query Parameters
limit
integer

This is a query param to indicate the maximun numbers of alarms to return. The default value will be -1 for all alarms.

offset
integer

This is a query param to indicate the number of alarms to skip. The default value is 0.

sort
string

The sort order. Sorting to apply to the issuedAt attribute. The default order will be DESC.

filters
object

The filter is applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: eventName. If no filter is applied, send an empty JSON or null. In there, the 'value' of this query is an enum of: "IN", "OUT", and "THRESHOLD", the startDate and endDate attributes in ISO format(ex: "2020-03-02T07:26:34.250Z"). If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'isAcknowledged': 'siteName'. ex: filter with object: {"startDate": "2023-07-12T02:20:08.377Z", "endDate":"2023-07-13T02:20:08.377Z", "isAcknowledged": true}

populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alarms have been successfully fetched.",
  • "data": {
    }
}

Get geo-notification alarm or push button alarm by id

This API allows to get a geo-notification alarm or a push button alarm by id.

path Parameters
alarmId
required
string

This is a path param for alarmId

query Parameters
populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The alarm has been successfully fetched.",
  • "data": {
    }
}

[Depreciated] Get geonotification alarms of user sites

This API allows to fetch all geonotification alarms that have been generated for all user sites. You can use in this case the API 'Get geonotification alarms for user sites'.

query Parameters
startDate
date

This is a query param for start date in ISO format

endDate
date

This is a query param for end date in ISO format

limit
number

Define how many maximun records should be sent in request data

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geonotifications alarms have been successfully fetched.",
  • "data": [
    ]
}

Delete geonotification alarms from list

This API allows to delete all geonotification alarms from a given list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of geonotitication alarms to delete. The value '*' if the user delete all geonotifications.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Geonotification alarms have been successfully deleted.",
  • "data": {
    }
}

[Depreciated] Get geonotification alarms for site

This API allows to fetch all geonotification alarms that have been generated for a given site. You can use in this case the API 'Get geonotification alarms for site'.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
startDate
date

This is a query param for start date in ISO format

endDate
date

This is a query param for end date in ISO format

limit
number

Define how many maximun records should be sent in request data

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geonotifications alarms have been successfully fetched.",
  • "data": [
    ]
}

Delete geonotification alarms from list for site

This API allows to delete all geonotification alarms from a given list for site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of geonotitication alarms to delete. The value '*' if the user delete all geonotifications.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Geonotification alarms have been successfully deleted.",
  • "data": {
    }
}

Acknowledge list of geonotification alarms

This API allows to acknowledge geonotification alarms from a given list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of geonotitication alarms to acknowledge. The value '*' if the user update acknowledge all geonotifications.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Geonotification alarms have been successfully acknowledged.",
  • "data": {
    }
}

Acknowledge list of geonotification alarms for site

This API allows to acknowledge geonotification alarms from a given list for a site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of geonotitication alarms to acknowledge. The value '*' if the user update acknowledge all geonotifications.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Geonotification alarms have been successfully acknowledged.",
  • "data": {
    }
}

[Depreciated] Get push button alarms of user sites

This API allows to fetch all push button alarms that have been generated for all user sites. You can use in this case the API 'Get push button alarms of user sites'.

query Parameters
startDate
date

This is a query param for start date in ISO format

endDate
date

This is a query param for end date in ISO format

limit
number

Define how many maximun records should be sent in request data

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push buttons alarms have been successfully fetched.",
  • "data": [
    ]
}

Delete push button alarms from list

This API allows to delete all push button alarms from a given list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of push button alarms to delete. The value '*' if the user delete all push button alarms.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Push button alarms have been successfully deleted.",
  • "data": {
    }
}

[Depreciated] Get push button alarms for site

This API allows to fetch all push button alarms that have been generated for a given site. You can use in this case the API 'Get push button alarms for sites'.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
startDate
date

This is a query param for start date in ISO format

endDate
date

This is a query param for end date in ISO format

limit
number

Define how many maximun records should be sent in request data

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push buttons alarms have been successfully fetched.",
  • "data": [
    ]
}

Delete push button alarms from list for site

This API allows to delete all push button alarms from a given list for site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of push button alarms to delete. The value '*' if the user delete all push button alarms.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Push button alarms have been successfully deleted.",
  • "data": {
    }
}

Acknowledge list of push buttonalarms

This API allows to acknowledge push button alarms from a given list.

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of push button alarms to acknowledge. The value '*' if the user update acknowledge all push button alarms.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Push button alarms have been successfully acknowledged.",
  • "data": {
    }
}

Acknowledge list of push buttonalarms for a site

This API allows to acknowledge push button alarms from a given list for a site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
alarms
required
Array of strings

An array of strings containing alarmId of push button alarms to acknowledge. The value '*' if the user update acknowledge all push button alarms.

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Push button alarms have been successfully acknowledged.",
  • "data": {
    }
}

Get geonotification alarms for site

This API allows to fetch all geonotification alarms that have been generated for the site.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
limit
integer

This is a query param to indicate the maximun numbers of alarms to return. The default value will be -1 for all alarms.

offset
integer

This is a query param to indicate the number of alarms to skip. The default value is 0.

sort
string

The sort order. Sorting to apply to the issuedAt attribute. The default order will be DESC.

populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, geofence, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

filters
object

Filters are applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: eventName. If no filter is applied, send an empty JSON or null. In there, the 'value' of this query is an enum of: "IN", "OUT", and "THRESHOLD", the startDate and endDate attributes in ISO format(ex: "2020-03-02T07:26:34.250Z"). If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'startDate', 'isAcknowledged', 'siteName'. ex: filter with object: {"startDate": "2023-07-12T02:20:08.377Z", "isAcknowledged": true, "siteName": "site 1"}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geonotifications alarms have been successfully fetched.",
  • "data": {
    }
}

Get push button alarms for sites

This API allows to fetch all push button alarms that have been generated for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
limit
integer

This is a query param to indicate the maximun numbers of alarms to return. The default value will be -1 for all alarms.

offset
integer

This is a query param to indicate the number of alarms to skip. The default value is 0.

sort
string

The sort order. Sorting to apply to the issuedAt attribute. The default order will be DESC.

populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, pusheventtype, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

filters
object

Filters are applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: eventName. If no filter is applied, send an empty JSON or null. In there, the startDate and endDate attributes in ISO format(ex: "2020-03-02T07:26:34.250Z"). If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'startDate', 'isAcknowledged', 'siteName'. ex: filter with object: {"startDate": "2023-07-12T02:20:08.377Z", "isAcknowledged": true, "siteName": "site 1"}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push buttons alarms have been successfully fetched.",
  • "data": {
    }
}

Get geonotification alarms for user sites

This API allows to fetch all geonotification alarms that have been generated for all user sites.

query Parameters
limit
integer

This is a query param to indicate the maximun numbers of alarms to return. The default value will be -1 for all alarms.

offset
integer

This is a query param to indicate the number of alarms to skip. The default value is 0.

sort
string

The sort order. Sorting to apply to the issuedAt attribute. The default order will be DESC.

populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, geofence, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

filters
object

Filters are applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: eventName. If no filter is applied, send an empty JSON or null. In there, the 'value' of this query is an enum of: "IN", "OUT", and "THRESHOLD", the startDate and endDate attributes in ISO format(ex: "2020-03-02T07:26:34.250Z"). If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'startDate', 'isAcknowledged', 'siteName'. ex: filter with object: {"startDate": "2023-07-12T02:20:08.377Z", "isAcknowledged": true, "siteName": "site 1"}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The geonotifications alarms have been successfully fetched.",
  • "data": {
    }
}

Get push button alarms of user sites

This API allows to fetch all push button alarms that have been generated for all user sites.

query Parameters
limit
integer

This is a query param to indicate the maximun numbers of alarms to return. The default value will be -1 for all alarms.

offset
integer

This is a query param to indicate the number of alarms to skip. The default value is 0.

sort
string

The sort order. Sorting to apply to the issuedAt attribute. The default order will be DESC.

populate
string

The populate allows getting the element associated with alarm history. ex: site, tag, pusheventtype, asset. If the user send a value is "*" then get all elements associated with alarms history. If no populate is applied, the defautl value will be null or empty.

filters
object

Filters are applied to filter the value of a specific object field in the record. The field name in the filter object corresponds to the field in one record, for example: eventName. If no filter is applied, send an empty JSON or null. In there, the startDate and endDate attributes in ISO format(ex: "2020-03-02T07:26:34.250Z"). If you want to find the exact value of this field, send a string instead an object for this fieldName, ex: 'startDate', 'isAcknowledged', 'siteName'. ex: filter with object: {"startDate": "2023-07-12T02:20:08.377Z", "isAcknowledged": true, "siteName": "site 1"}

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The push buttons alarms have been successfully fetched.",
  • "data": {
    }
}

Fingerprint

Get Fingerprint status

This API allows to get the latest fingerprint status for a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The latest Fingerprint Status has been successfully fecthed",
  • "data": {
    }
}

Report

Generate a report

This API allows to generate a new report.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
reportType
required
string
Enum: "INSTANT_INVENTORY" "LAST_SEARCHES" "CUSTOMFIELDS_HISTORY" "GEOFENCES_HISTORY" "GEONOTIFICATIONS_HISTORY" "ASSET_ASSOCIATION_INVENTORY" "LAST_KNOWN_POSITION"

The type of the report.

from
string <date-time>

The start date of the report. The ISO 8601 format is mandatory.

to
string <date-time>

The end date of the report. The ISO 8601 format is mandatory.

reportFormat
required
string
Enum: "CSV" "XLS"

The format of the report.

arrayOfEmails
required
Array of strings

The email distribution list for the report.

timezone
string
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/NSW" "Australia/North" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "CET" "CST6CDT" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "EET" "EST" "EST5EDT" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "GMT" "GMT+0" "GMT-0" "GMT0" "Greenwich" "HST" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "MET" "MST" "MST7MDT" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "NZ" "NZ-CHAT" "Navajo" "PRC" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "ROC" "ROK" "Singapore" "Turkey" "UCT" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa" "UTC" "Universal" "W-SU" "WET" "Zulu"

Timezone of the user who generated the report. The default timezone will be UTC.

Responses

Request samples

Content type
application/json
{
  • "reportType": "INSTANT_INVENTORY",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "reportFormat": "CSV",
  • "arrayOfEmails": [
    ],
  • "timezone": "Africa/Abidjan"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully generated.",
  • "data": [
    ]
}

Create a report

This API allows to create a new report.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the report

reportTemplate
required
string
Enum: "INSTANT_INVENTORY" "LAST_SEARCHES" "CUSTOMFIELDS_HISTORY" "GEOFENCES_HISTORY" "GEONOTIFICATIONS_HISTORY" "ASSET_ASSOCIATION_INVENTORY" "LAST_KNOWN_POSITION"

The report template of the report.

emails
required
Array of strings

An arrays email of the report.

fileType
required
string
Enum: "CSV" "XLS"

The file type of the report.

from
string <date-time>

The start date of the report. The ISO 8601 format is mandatory.

to
string <date-time>

The end date of the report. The ISO 8601 format is mandatory.

timeZone
required
string
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/NSW" "Australia/North" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "CET" "CST6CDT" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "EET" "EST" "EST5EDT" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "GMT" "GMT+0" "GMT-0" "GMT0" "Greenwich" "HST" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "MET" "MST" "MST7MDT" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "NZ" "NZ-CHAT" "Navajo" "PRC" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "ROC" "ROK" "Singapore" "Turkey" "UCT" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa" "UTC" "Universal" "W-SU" "WET" "Zulu"

Timezone of the user who generated the report. The default timezone will be UTC.

reportType
required
string
Enum: "SCHEDULED" "ON_DEMAND"

The type of the report.

object

The scheduler of the report

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportTemplate": "INSTANT_INVENTORY",
  • "emails": [
    ],
  • "fileType": "CSV",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "timeZone": "Africa/Abidjan",
  • "reportType": "SCHEDULED",
  • "scheduler": {
    }
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The report has been successfully created.",
  • "data": {
    }
}

Get reports for site

This API allows to get reports for site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The reports have been successfully fetched.",
  • "data": [
    ]
}

Update a report

This API allows to update a report.

path Parameters
siteId
required
string

This is a path param for siteId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the report

reportTemplate
required
string
Enum: "INSTANT_INVENTORY" "LAST_SEARCHES" "CUSTOMFIELDS_HISTORY" "GEOFENCES_HISTORY" "GEONOTIFICATIONS_HISTORY" "ASSET_ASSOCIATION_INVENTORY" "LAST_KNOWN_POSITION"

The report template of the report.

emails
required
Array of strings

An arrays email of the report.

fileType
required
string
Enum: "CSV" "XLS"

The file type of the report.

from
string <date-time>

The start date of the report. The ISO 8601 format is mandatory.

to
string <date-time>

The end date of the report. The ISO 8601 format is mandatory.

timeZone
required
string
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/NSW" "Australia/North" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "CET" "CST6CDT" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "EET" "EST" "EST5EDT" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "GMT" "GMT+0" "GMT-0" "GMT0" "Greenwich" "HST" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "MET" "MST" "MST7MDT" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "NZ" "NZ-CHAT" "Navajo" "PRC" "PST8PDT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "ROC" "ROK" "Singapore" "Turkey" "UCT" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa" "UTC" "Universal" "W-SU" "WET" "Zulu"

Timezone of the user who generated the report. The default timezone will be UTC.

reportType
required
string
Enum: "SCHEDULED" "ON_DEMAND"

The type of the report.

object

The scheduler of the report

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reportTemplate": "INSTANT_INVENTORY",
  • "emails": [
    ],
  • "fileType": "CSV",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "timeZone": "Africa/Abidjan",
  • "reportType": "SCHEDULED",
  • "scheduler": {
    }
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully updated.",
  • "data": {
    }
}

Get report by id

This API allows to get report by id.

path Parameters
siteId
required
string

This is a path param for siteId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully fetched.",
  • "data": {
    }
}

Delete report by id

This API allows to delete report by id.

path Parameters
siteId
required
string

This is a path param for siteId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report has been successfully deleted.",
  • "data": {
    }
}

Update a report status

This API allows to update report status.

path Parameters
siteId
required
string

This is a path param for siteId

reportId
required
string

This is a path param for reportId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
isActive
required
boolean

The status active of the schedule.

Responses

Request samples

Content type
application/json
{
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The report status has been successfully updated.",
  • "data": {
    }
}

Pii

Get Personally Identifiable Information (PII) for a given site

This API allows to list the keys required to access Personally Identifiable Information (PII) for a given Site. The purpose of this API is to let the user know what are the PII keys that are available within Asset Tracking for the given site. As a second step, the user can invoke another API on a specific key from the output of this API to get the historical location data of the PII key.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The PIIs data have been successfully fetched.",
  • "data": [
    ]
}

Get historical location data of a given Personally Identifiable Information (PII) key

The purpose of this API is to let the user accessing the historical location of one PII key retrieved from the GET Personally Identifiable Information (PII) API.

path Parameters
siteId
required
string

This is a path param for siteId

piiId
required
string

This is a path param for piiId

query Parameters
startDate
required
integer

This is a query param for start date in milliseconds timestamp format

endDate
required
integer

This is a query param for end date in milliseconds timestamp format

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The PII locations have been successfully fetched.",
  • "data": {
    }
}

Contacteventsetting

Get contact event settings for a given site

This API allows to fetch contact event settings associated to a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The contact event setting has been successfully fetched.",
  • "data": {
    }
}

Update contact event setting

This API allows to update one contact event setting identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

contactEventSettingId
required
string

This is a path param for contactEventSettingId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
riskLevel
required
integer <int32>

The percentage of contact risk level above which it will be displayed in red in the contact events list. The value must be between 0 and 100.

Responses

Request samples

Content type
application/json
{
  • "riskLevel": 0
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The contact event setting has been successfully updated.",
  • "data": {
    }
}

Assetunit

Create an asset unit

This API allows to registering of a new asset unit in a given site.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Content-Type
required
string

application/json

Request Body schema: application/json
required
name
required
string

The name of the asset unit.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "The asset unit has been successfully created.",
  • "data": {
    }
}

Get asset units of site

This API allows to fetch all asset units of site available in the solution.

path Parameters
siteId
required
string

This is a path param for siteId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset units have been successfully fetched.",
  • "data": [
    ]
}

Update an asset unit

This API allows to update asset unit of site available in the solution.

path Parameters
siteId
required
string

This is a path param for siteId

assetUnitId
required
string

This is a path param for assetUnitId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Request Body schema: application/json
required
name
required
string

The name of the asset unit.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The site asset unit has been successfully updated.",
  • "data": {
    }
}

Delete an asset

This API allows to delete an asset unit identified by its id.

path Parameters
siteId
required
string

This is a path param for siteId

assetUnitId
required
string

This is a path param for assetUnitId

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The asset unit has been successfully deleted.",
  • "data": {
    }
}

Assetassocdisassochistory

Get site assets activation and deactivation history

This API allows to fetch the history of assets activation and deactivation of site identified by its id. The information will be displayed in logged user language (french or english).

path Parameters
siteId
required
string

This is a path param for siteId

query Parameters
startDate
required
date

This is a query param for start date in ISO format

endDate
required
date

This is a query param for end date in ISO format

header Parameters
Authorization
required
string

Bearer {{access_token}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "The history of assets activation and deactivation has been successfully fetched.",
  • "data": [
    ]
}