Introduction

Say something clever here about the REST API…​

Overview

HTTP verbs

The LocatorX REST API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, including partial updates

DELETE

Used to delete an existing resource

HTTP status codes

The LocatorX REST API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401 Unauthorized

The server can not process the request because it lacks valid authentication credentials for the target resource.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

Resources

REST API Authentication

Unless noted otherwise, the REST APIs use an HHTP header authentication token for security.

Header authentication token

Name Description

Auth-Token

Token based authentication credentials.

or

Name Description

CSM

Token based authentication credentials.

REST API Response

Unless noted otherwise, the REST APIs will always return the following as part of the response body.

Common response fields

Path Type Description

success

Boolean

true: the request succeeded. false: the request failed.

Common response body

{
  "success" : true
}

Action Types

The Action Types resource is used to create, modify, delete and list action types.

Listing action types

A GET request lists action types.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/actionTypes' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:39 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1062
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "actionTypes" : [ {
    "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
    "name" : "smick",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "actionTypeId" : "2fc961e6-60cf-4405-b225-fa4aeac20e54",
    "form" : {
      "name" : "Edit Asset",
      "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "fields" : [ {
        "fieldKey" : "note",
        "defaultValue" : "",
        "description" : "Enter a notation",
        "label" : "Notation",
        "fieldType" : "text"
      } ],
      "fieldsList" : [ {
        "fieldKey" : "note",
        "defaultValue" : "",
        "description" : "Enter a notation",
        "label" : "Notation",
        "fieldType" : "text"
      } ]
    }
  }, {
    "formId" : "45f869f2-140e-425d-b036-2e630d239e55",
    "name" : "Action Type One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "actionTypeId" : "db8c5ddc-40c3-429e-8c6f-ec01f5d59347"
  } ]
}

Fetching action types

A GET request fetches a specific action type by id.

Example request parameters

Table 1. /lx-atlas/api/actionTypes/{<actionTypeId>}
Parameter Description

<actionTypeId>

The action type id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/actionTypes/2fc961e6-60cf-4405-b225-fa4aeac20e54' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:39 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 835
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "actionType" : {
    "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
    "name" : "smick",
    "actionTypeId" : "2fc961e6-60cf-4405-b225-fa4aeac20e54",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "form" : {
      "name" : "Edit Asset",
      "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "fields" : [ {
        "fieldKey" : "note",
        "defaultValue" : "",
        "description" : "Enter a notation",
        "label" : "Notation",
        "fieldType" : "text"
      } ],
      "fieldsList" : [ {
        "fieldKey" : "note",
        "defaultValue" : "",
        "description" : "Enter a notation",
        "label" : "Notation",
        "fieldType" : "text"
      } ]
    }
  },
  "success" : true
}

Creating action types

A POST request creates a new action type.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization of the user.

name

String

The name of the action type.

formId

String

The optional form id. Default is no form id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/actionTypes' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "New ActionType"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 207
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "actionType" : {
    "name" : "New ActionType",
    "actionTypeId" : "67493bec-5ac4-4d5b-9fe5-c250791139b4",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  },
  "success" : true
}

Updating action types

A PUT request updates an action type.

Request parameters definition

Table 2. /lx-atlas/api/actionTypes/{<actionTypeId>}
Parameter Description

<actionTypeId>

The action type id.

Request body definition

Path Type Description

name

String

The optional name of the action type. Default is the name is not changed.

formId

String

The optional form id. Default is the form id is not changed.

organizationId

String

The optional organization id. Default is the organization id is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/actionTypes/db8c5ddc-40c3-429e-8c6f-ec01f5d59347' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "ActionType Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 272
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "actionType" : {
    "formId" : "45f869f2-140e-425d-b036-2e630d239e55",
    "name" : "ActionType Name Changed",
    "actionTypeId" : "db8c5ddc-40c3-429e-8c6f-ec01f5d59347",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  },
  "success" : true
}

Deleting action types

A DELETE request deletes an action type.

Request parameters definition

Table 3. /lx-atlas/api/actionTypes/{<actionTypeId>}
Parameter Description

<actionTypeId>

The action type id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/actionTypes/db8c5ddc-40c3-429e-8c6f-ec01f5d59347' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Assemblies

The Assemblies resource is used to create, modify, delete and list assemblies.

Listing assemblies

A GET request lists assemblies.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assemblies' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 992
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "assemblies" : [ {
    "referenceId" : "43825bd3-56b6-401a-a7e1-1d43d528b540",
    "status" : "current",
    "assemblyType" : "Type One",
    "name" : "Assembly One",
    "timeStarted" : "20210510160636",
    "timeEnded" : "20210511160636",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "assemblyId" : "1eed2921-f439-4e0d-90aa-4dd6bf599d28",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }, {
    "referenceId" : "15865b10-292d-4abb-a106-c38c8e9b7257",
    "status" : "pending",
    "assemblyType" : "Type Two",
    "name" : "Assembly Two",
    "timeStarted" : "20210511160636",
    "timeEnded" : "20210512160636",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "assemblyId" : "413ccb3a-619f-41db-ad82-d2efb8709471",
    "propertiesMap" : {
      "Two-One" : "One",
      "Two-Three" : "Three",
      "Two-Two" : "Two"
    }
  } ],
  "success" : true
}

Fetching assemblies

A GET request fetches a specific assembly by id.

Example request parameters

Table 4. /lx-atlas/api/assemblies/{<assemblyId>}
Parameter Description

<assemblyId>

The assembly id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assemblies/7a8ea8d2-a795-4975-b0b2-0b2286bcca1c' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:41 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 513
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "assembly" : {
    "referenceId" : "43825bd3-56b6-401a-a7e1-1d43d528b540",
    "status" : "current",
    "assemblyType" : "Type One",
    "name" : "Assembly One",
    "timeStarted" : "20210510160636",
    "timeEnded" : "20210511160636",
    "assemblyId" : "7a8ea8d2-a795-4975-b0b2-0b2286bcca1c",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Creating assemblies

A POST request creates a new assembly.

Request body definition

Path Type Description

name

String

The name of the assembly.

organizationId

String

The optional organization id. Default is the organization of the user.

status

String

The optional assembly status. Valid values are: pending, current, expired, visible.

referenceId

String

The optional reference id.

assemblyType

String

The optional assembly type.

note

String

The optional note.

propertiesMap

Object

The optional properties as a map. Example: "propertiesMap": { "key": "value" }

timeStarted

String

The optional time started. Valid formates: yyyyMMddHHmm

timeEnded

String

The optional time ended. Valid formates: yyyyMMddHHmm

assetIds

Array

The optional list or set of associated asset ids. Example: "assetIds": ["29593378-764f-4dfc-8fd0-d5293162c050"]

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assemblies' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "referenceId" : "3a89c5c4-4286-408a-8af8-f3cf64c398a1",
  "status" : "current",
  "assemblyType" : "Type One",
  "name" : "Assembly One",
  "timeStarted" : "20210503144032",
  "timeEnded" : "20210504144032",
  "propertiesMap" : {
    "One-Three" : "Three",
    "One-One" : "One",
    "One-Two" : "Two"
  }
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 437
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "assembly" : {
    "referenceId" : "3a89c5c4-4286-408a-8af8-f3cf64c398a1",
    "status" : "current",
    "assemblyType" : "Type One",
    "name" : "Assembly One",
    "assemblyId" : "43d8ecbc-91d5-44f9-a53d-a116edd0220e",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Updating assemblies

A PUT request updates an assembly.

Request parameters definition

Table 5. /lx-atlas/api/assemblies/{<assemblyId>}
Parameter Description

<assemblyId>

The assembly id.

Request body definition

Path Type Description

name

String

The name of the assembly. Default is the name is not changed.

organizationId

String

The optional organization id. Default is the organization id is not changed.

status

String

The optional assembly status. Valid values are: pending, current, expired, visible. Default is the assembly status is not changed.

referenceId

String

The optional reference id. Default is the reference id is not changed.

assemblyType

String

The optional assembly type. Default is the assembly type is not changed.

note

String

The optional note. Default is the note is not changed.

propertiesMap

Object

The optional properties as a map. Default is the properties are not changed.

timeStarted

String

The optional time started. Valid formates: yyyyMMddHHmm. Default is the time started is not changed.

timeEnded

String

The optional time ended. Valid formates: yyyyMMddHHmm. Default is the time ended is not changed.

assetIds

Array

The optional list or set of associated asset ids. Default is the asset ids are not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assemblies/79f3955e-2e65-4716-aff6-67ccac39184b' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Assembly Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:40 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 522
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "assembly" : {
    "referenceId" : "43825bd3-56b6-401a-a7e1-1d43d528b540",
    "status" : "current",
    "assemblyType" : "Type One",
    "name" : "Assembly Name Changed",
    "timeStarted" : "20210510160636",
    "timeEnded" : "20210511160636",
    "assemblyId" : "79f3955e-2e65-4716-aff6-67ccac39184b",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Deleting assemblies

A DELETE request deletes an assembly.

Request parameters definition

Table 6. /lx-atlas/api/assemblies/{<assemblyId>}
Parameter Description

<assemblyId>

The assembly id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assemblies/6bcfb06c-e7f4-4c8c-973e-09fc47c6ec35' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:41 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Assets

The Assets resource is used to create, modify, delete, list and interrogate assets and related resources.

Listing assets

A POST request lists assets.

Request body definition

Path Type Description

assetIds

Array

The list of asset ids.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/assetIds' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "assetIds" : [ "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e", "f182afaa-5fc4-4761-abb3-e17c91963a16" ]
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:42 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 5199
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "assets" : [ {
    "appUserId" : "e3737d99-af6c-49bf-b330-1061b2bd4bc2",
    "assemblies" : [ "5b590df3-3034-4d90-9405-eaf3bf04260a", "d00ff634-efff-475b-b67b-095118a73a6b" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "classificationSet" : [ "7f0b1faa-695e-4fed-af1c-b744052ed134" ],
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "9ef6d6de-6126-45f5-996d-17295e52a2e1",
      "lastMovementTime" : "20210510160636",
      "lastReportTime" : "20210510160636",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "0891e451-2615-4756-9466-683ee5fc8d49",
    "facility" : "Facility One",
    "facilityId" : "a770fff0-bce5-4843-9211-487902ae3404",
    "firstName" : "First Name One",
    "flagged" : false,
    "lastEvent" : "Last Event One",
    "lastName" : "Last Name One",
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105111606",
    "pcaKeyId" : "afb1d203-bbc0-41c6-9114-601531ba5701",
    "postalCode" : "03801",
    "productTag" : "Product Tag One",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "timeModified" : "20210510160636",
    "timeOfLog" : "20210510160636",
    "zone" : {
      "zoneId" : "9fd4cd90-fdba-45d8-af99-89cbadd095da",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assetId" : "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e",
    "batchId" : "04e1ed35-6339-4f12-865e-168276c5306d",
    "currentOwnerId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d818eed9-30e5-48b4-8eae-167cc29ce583",
    "productId" : "c4557e95-668d-4651-bffc-bad92503971b",
    "images" : [ ],
    "timeOfLogLong" : 1620662796867,
    "timeCreatedLong" : 1620662796867,
    "timeModifiedString" : "05/10/2021",
    "timeOfLogSeconds" : 1620662796,
    "timeModifiedLong" : 1620662796867,
    "timeOfLogString" : "05/10/2021",
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662796,
    "timeModifiedSeconds" : 1620662796,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }, {
    "appUserId" : "ed82ecd9-efd3-4376-bbf1-2cb9d418e177",
    "assemblies" : [ "00e8eef6-1c8e-4bae-ba60-eec0c16797bc", "b6822a44-bef9-449d-a877-70a06ffeefcb" ],
    "assetType" : "Asset Type Two",
    "category" : "Category Two",
    "city" : "Dover",
    "country" : "US",
    "classificationSet" : [ "f005f238-cfdc-4ad1-ab2e-d425af44bf75" ],
    "device" : {
      "assetMAC" : "Asset MAC Two",
      "batteryPercent" : 2,
      "platform" : "Platform Two",
      "serialNumber" : 200000,
      "externalId" : "5117f184-99e0-45f9-b8aa-7bac134fd96e",
      "lastMovementTime" : "20210511160636",
      "lastReportTime" : "20210511160636",
      "lot" : 2,
      "panel" : 2,
      "part" : 2,
      "revision" : "Revision Two",
      "status" : "requested"
    },
    "externalId" : "5c65fae2-a5b5-4abf-8909-004046d2cd49",
    "facility" : "Facility Two",
    "facilityId" : "44d1816f-1f25-4d9d-acda-ebd8b7c3da02",
    "firstName" : "First Name Two",
    "flagged" : false,
    "lastEvent" : "Last Event Two",
    "lastName" : "Last Name Two",
    "latitude" : 43.19701,
    "longitude" : -70.87093,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105121606",
    "pcaKeyId" : "c026486f-9c67-4b8c-b592-f8cc4f702fda",
    "postalCode" : "03820",
    "productTag" : "Product Tag Two",
    "rev" : 2,
    "serialNumber" : 2000000,
    "state" : "NH",
    "tag" : "Tag Two",
    "timeCreated" : "20210511160636",
    "timeModified" : "20210511160636",
    "timeOfLog" : "20210511160636",
    "zone" : {
      "zoneId" : "914d086e-fd4f-4c0b-8b03-de5daf8d1a41",
      "x" : 2.0,
      "y" : 2.0,
      "z" : 2.0,
      "binLocation" : "Bin Two"
    },
    "assetId" : "f182afaa-5fc4-4761-abb3-e17c91963a16",
    "batchId" : "36280351-be2a-43a8-bff3-b4d2ac24552b",
    "currentOwnerId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "da503bbd-bdf5-4ed7-9ced-2050b4960d13",
    "productId" : "3211b2cd-38d4-4525-8aa6-d8738670c2ae",
    "images" : [ ],
    "timeOfLogLong" : 1620749196868,
    "timeCreatedLong" : 1620749196868,
    "timeModifiedString" : "05/11/2021",
    "timeOfLogSeconds" : 1620749196,
    "timeModifiedLong" : 1620749196868,
    "timeOfLogString" : "05/11/2021",
    "timeCreatedString" : "05/11/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620749196,
    "timeModifiedSeconds" : 1620749196,
    "propertiesMap" : {
      "Two-One" : "One",
      "Two-Three" : "Three",
      "Two-Two" : "Two"
    }
  } ],
  "success" : true
}

Fetching assets

A GET request fetches a specific asset by id.

Example request parameters

Table 7. /lx-atlas/api/assets/{<assetId>}
Parameter Description

<assetId>

The asset id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:42 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 2662
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "recentScans" : [ ],
  "success" : true,
  "asset" : {
    "appUserId" : "e3737d99-af6c-49bf-b330-1061b2bd4bc2",
    "assemblies" : [ "5b590df3-3034-4d90-9405-eaf3bf04260a", "d00ff634-efff-475b-b67b-095118a73a6b" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "classificationSet" : [ "7f0b1faa-695e-4fed-af1c-b744052ed134" ],
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "9ef6d6de-6126-45f5-996d-17295e52a2e1",
      "lastMovementTime" : "20210510160636",
      "lastReportTime" : "20210510160636",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "0891e451-2615-4756-9466-683ee5fc8d49",
    "facility" : "Facility One",
    "facilityId" : "a770fff0-bce5-4843-9211-487902ae3404",
    "firstName" : "First Name One",
    "flagged" : false,
    "lastEvent" : "Last Event One",
    "lastName" : "Last Name One",
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105111606",
    "pcaKeyId" : "afb1d203-bbc0-41c6-9114-601531ba5701",
    "postalCode" : "03801",
    "productTag" : "Product Tag One",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "timeModified" : "20210510160636",
    "timeOfLog" : "20210510160636",
    "zone" : {
      "zoneId" : "9fd4cd90-fdba-45d8-af99-89cbadd095da",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assets" : [ ],
    "assetId" : "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e",
    "batchId" : "04e1ed35-6339-4f12-865e-168276c5306d",
    "currentOwnerId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d818eed9-30e5-48b4-8eae-167cc29ce583",
    "productId" : "c4557e95-668d-4651-bffc-bad92503971b",
    "images" : [ ],
    "timeOfLogLong" : 1620662796867,
    "timeCreatedLong" : 1620662796867,
    "timeModifiedString" : "05/10/2021",
    "timeOfLogSeconds" : 1620662796,
    "timeModifiedLong" : 1620662796867,
    "timeOfLogString" : "05/10/2021",
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662796,
    "timeModifiedSeconds" : 1620662796,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Creating assets

A POST request creates a new asset.

Request body definition

Path Type Description

currentOwnerId

String

The optional current owner id. Default is the value is set to the organization id.

productId

String

The optional product id. Default is the value is not changed.

productTag

String

The optional product tag. Default is the value is not changed.

externalId

String

The optional external id. Default is the value is not changed.

serialNumber

Number

The optional serial number. Default is the value is not changed.

timeModified

String

The optional time modified. Default is the value is set to the current time.

rev

Number

The optional rev. Default is the time modified is not changed.

batchId

String

The optional batch id. Default is the batch id is not changed.

assetType

String

The optional asset type. Default is the value is not changed.

category

String

The optional category. Default is the value is not changed.

propertiesMap

Object

The optional properties map. Default is the value is not changed.

parentId

String

The optional parent id. Default is the value is not changed.

pcaKeyExpirationDate

String

The optional pcaKey expiration date. Default is the value is not changed.

pcaKeyId

String

The optional pcaKey Id. Default is the value is not changed.

facility

String

The optional facility. Default is the value is not changed.

facilityId

String

The optional facility id. Default is the value is not changed.

city

String

The optional city. Default is the value is not changed.

country

String

The optional country. Default is the value is not changed.

postalCode

String

The optional postal code. Default is the value is not changed.

state

String

The optional state. Default is the value is not changed.

latitude

Number

The optional latitude. Default is the value is not changed.

longitude

Number

The optional longitude. Default is the value is not changed.

flagged

Boolean

The optional flagged. Default is the value is not changed.

tag

String

The optional tag. Default is the value is not changed.

assemblies

Array

The optional assemblies. Default is the value is not changed.

classificationSet

Array

The optional classification set. Default is the value is not changed.

signature

String

The optional signature. Default is the value is not changed.

device

Object

The optional device. Default is the value is not changed.

zone

Object

The optional zone. Default is the value is not changed.

assetIds

Array

The optional asset ids. Default is the value is not changed.

assets

Array

The optional assets. Default is the value is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "assemblies" : [ "3ca89bc6-ad41-4adb-94ef-b7299c72f775", "ddd7b72f-245b-423b-9aec-c6401ae0f53e" ],
  "assetType" : "Asset Type One",
  "category" : "Category One",
  "city" : "Portsmouth",
  "country" : "US",
  "classificationSet" : [ "a3bc7eb8-02cb-4db7-b7f4-924e5c903a77" ],
  "device" : {
    "assetMAC" : "Asset MAC One",
    "batteryPercent" : 1,
    "platform" : "Platform One",
    "serialNumber" : 100000,
    "externalId" : "3f3acd76-bb59-4c6b-846b-a5cf471884a1",
    "lastMovementTime" : "20210507155117",
    "lastReportTime" : "20210507155117",
    "lot" : 1,
    "panel" : 1,
    "part" : 1,
    "revision" : "Revision One",
    "status" : "requested"
  },
  "externalId" : "28bf0a6f-5ca6-470d-b009-e3eb495a376c",
  "facility" : "Facility One",
  "facilityId" : "d4ab3d92-513f-4854-b183-a163bf5447e7",
  "flagged" : false,
  "latitude" : 43.071,
  "longitude" : -70.74515,
  "pcaKeyExpirationDate" : "202105081551",
  "pcaKeyId" : "bb43b5ec-8908-41e4-9ec1-8dfb82f42517",
  "postalCode" : "03801",
  "productTag" : "Product Tag One",
  "rev" : 1,
  "serialNumber" : 1000000,
  "state" : "NH",
  "tag" : "Tag One",
  "timeModified" : "20210507155122",
  "zone" : {
    "zoneId" : "b33c3078-ed22-42da-8b3e-91de011c6368",
    "x" : 1.0,
    "y" : 1.0,
    "z" : 1.0,
    "binLocation" : "Bin One"
  },
  "assets" : [ ],
  "batchId" : "2ec260d5-1313-465a-a6ce-883ad9cf5b9f",
  "currentOwnerId" : "00000000-0000-0000-0000-000000000000",
  "parentId" : "f0905024-b522-4c95-b2b7-8cb97a7aabbf",
  "productId" : "4adff44b-7aa3-42bf-8291-aace45f9c985",
  "propertiesMap" : {
    "One-Three" : "Three",
    "One-One" : "One",
    "One-Two" : "Two"
  }
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:43 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1926
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "asset" : {
    "assemblies" : [ "3ca89bc6-ad41-4adb-94ef-b7299c72f775", "ddd7b72f-245b-423b-9aec-c6401ae0f53e" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "00010101",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "28bf0a6f-5ca6-470d-b009-e3eb495a376c",
    "facility" : "Facility One",
    "facilityId" : "d4ab3d92-513f-4854-b183-a163bf5447e7",
    "flagged" : false,
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105081551",
    "pcaKeyId" : "bb43b5ec-8908-41e4-9ec1-8dfb82f42517",
    "postalCode" : "03801",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160643",
    "zone" : {
      "zoneId" : "b33c3078-ed22-42da-8b3e-91de011c6368",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assets" : [ ],
    "assetId" : "855593e4-1f59-4f09-82b2-058cea1d9179",
    "batchId" : "2ec260d5-1313-465a-a6ce-883ad9cf5b9f",
    "currentOwnerId" : "00000000-0000-0000-0000-000000000000",
    "parentId" : "f0905024-b522-4c95-b2b7-8cb97a7aabbf",
    "productId" : "4adff44b-7aa3-42bf-8291-aace45f9c985",
    "images" : [ ],
    "timeCreatedLong" : 1620662803026,
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662803,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Updating assets

A PUT request updates an asset.

Request parameters definition

Table 8. /lx-atlas/api/assets/{<assetId>}
Parameter Description

<assetId>

The asset id.

Request body definition

Path Type Description

currentOwnerId

String

The optional current owner id. Default is the value is set to the organization id.

productId

String

The optional product id. Default is the value is not changed.

productTag

String

The optional product tag. Default is the value is not changed.

externalId

String

The optional external id. Default is the value is not changed.

serialNumber

Number

The optional serial number. Default is the value is not changed.

timeModified

String

The optional time modified. Default is the value is set to the current time.

rev

Number

The optional rev. Default is the time modified is not changed.

batchId

String

The optional batch id. Default is the batch id is not changed.

assetType

String

The optional asset type. Default is the value is not changed.

category

String

The optional category. Default is the value is not changed.

propertiesMap

Object

The optional properties map. Default is the value is not changed.

parentId

String

The optional parent id. Default is the value is not changed.

pcaKeyExpirationDate

String

The optional pcaKey expiration date. Default is the value is not changed.

pcaKeyId

String

The optional pcaKey Id. Default is the value is not changed.

facility

String

The optional facility. Default is the value is not changed.

facilityId

String

The optional facility id. Default is the value is not changed.

city

String

The optional city. Default is the value is not changed.

country

String

The optional country. Default is the value is not changed.

postalCode

String

The optional postal code. Default is the value is not changed.

state

String

The optional state. Default is the value is not changed.

latitude

Number

The optional latitude. Default is the value is not changed.

longitude

Number

The optional longitude. Default is the value is not changed.

flagged

Boolean

The optional flagged. Default is the value is not changed.

tag

String

The optional tag. Default is the value is not changed.

assemblies

Array

The optional assemblies. Default is the value is not changed.

classificationSet

Array

The optional classification set. Default is the value is not changed.

signature

String

The optional signature. Default is the value is not changed.

device

Object

The optional device. Default is the value is not changed.

zone

Object

The optional zone. Default is the value is not changed.

assetIds

Array

The optional asset ids. Default is the value is not changed.

assets

Array

The optional assets. Default is the value is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "currentOwnerId" : "00000000-0000-0000-0000-000000000000"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:42 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 2638
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "asset" : {
    "appUserId" : "e3737d99-af6c-49bf-b330-1061b2bd4bc2",
    "assemblies" : [ "5b590df3-3034-4d90-9405-eaf3bf04260a", "d00ff634-efff-475b-b67b-095118a73a6b" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "classificationSet" : [ "7f0b1faa-695e-4fed-af1c-b744052ed134" ],
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "9ef6d6de-6126-45f5-996d-17295e52a2e1",
      "lastMovementTime" : "20210510160636",
      "lastReportTime" : "20210510160636",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "0891e451-2615-4756-9466-683ee5fc8d49",
    "facility" : "Facility One",
    "facilityId" : "a770fff0-bce5-4843-9211-487902ae3404",
    "firstName" : "First Name One",
    "flagged" : false,
    "lastEvent" : "Last Event One",
    "lastName" : "Last Name One",
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105111606",
    "pcaKeyId" : "afb1d203-bbc0-41c6-9114-601531ba5701",
    "postalCode" : "03801",
    "productTag" : "Product Tag One",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "timeModified" : "20210510160642",
    "timeOfLog" : "20210510160636",
    "zone" : {
      "zoneId" : "9fd4cd90-fdba-45d8-af99-89cbadd095da",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assets" : [ ],
    "assetId" : "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e",
    "batchId" : "04e1ed35-6339-4f12-865e-168276c5306d",
    "currentOwnerId" : "00000000-0000-0000-0000-000000000000",
    "parentId" : "d818eed9-30e5-48b4-8eae-167cc29ce583",
    "productId" : "c4557e95-668d-4651-bffc-bad92503971b",
    "images" : [ ],
    "timeOfLogLong" : 1620662796867,
    "timeCreatedLong" : 1620662796867,
    "timeModifiedString" : "05/10/2021",
    "timeOfLogSeconds" : 1620662796,
    "timeModifiedLong" : 1620662802812,
    "timeOfLogString" : "05/10/2021",
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662796,
    "timeModifiedSeconds" : 1620662802,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Verifying asset signatures via JSON

A GET request verifies an assets signature.

Request parameters definition

Table 9. /lx-atlas/api/assets/{<assetId>}/verifySignature
Parameter Description

<assetId>

The asset id.

Request body definition

Path Type Description

signature

String

The signature to verify.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/verifySignature' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "signature" : "Signature One"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:41 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 2618
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : false,
  "asset" : {
    "appUserId" : "e3737d99-af6c-49bf-b330-1061b2bd4bc2",
    "assemblies" : [ "5b590df3-3034-4d90-9405-eaf3bf04260a", "d00ff634-efff-475b-b67b-095118a73a6b" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "classificationSet" : [ "7f0b1faa-695e-4fed-af1c-b744052ed134" ],
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "9ef6d6de-6126-45f5-996d-17295e52a2e1",
      "lastMovementTime" : "20210510160636",
      "lastReportTime" : "20210510160636",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "0891e451-2615-4756-9466-683ee5fc8d49",
    "facility" : "Facility One",
    "facilityId" : "a770fff0-bce5-4843-9211-487902ae3404",
    "firstName" : "First Name One",
    "flagged" : false,
    "lastEvent" : "Last Event One",
    "lastName" : "Last Name One",
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105111606",
    "pcaKeyId" : "afb1d203-bbc0-41c6-9114-601531ba5701",
    "postalCode" : "03801",
    "productTag" : "Product Tag One",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "timeModified" : "20210510160636",
    "timeOfLog" : "20210510160636",
    "zone" : {
      "zoneId" : "9fd4cd90-fdba-45d8-af99-89cbadd095da",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assetId" : "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e",
    "batchId" : "04e1ed35-6339-4f12-865e-168276c5306d",
    "currentOwnerId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d818eed9-30e5-48b4-8eae-167cc29ce583",
    "productId" : "c4557e95-668d-4651-bffc-bad92503971b",
    "images" : [ ],
    "timeOfLogLong" : 1620662796867,
    "timeCreatedLong" : 1620662796867,
    "timeModifiedString" : "05/10/2021",
    "timeOfLogSeconds" : 1620662796,
    "timeModifiedLong" : 1620662796867,
    "timeOfLogString" : "05/10/2021",
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662796,
    "timeModifiedSeconds" : 1620662796,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Verifying asset signatures via PATH

A GET request verifies an assets signature.

Request parameters definition

Table 10. /lx-atlas/api/assets/{<assetId>}/verifySignature/{<signature>}
Parameter Description

<assetId>

The asset id.

<signature>

The signature to verify.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/verifySignature/Signature%20One' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:41 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 2618
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : false,
  "asset" : {
    "appUserId" : "e3737d99-af6c-49bf-b330-1061b2bd4bc2",
    "assemblies" : [ "5b590df3-3034-4d90-9405-eaf3bf04260a", "d00ff634-efff-475b-b67b-095118a73a6b" ],
    "assetType" : "Asset Type One",
    "category" : "Category One",
    "city" : "Portsmouth",
    "country" : "US",
    "classificationSet" : [ "7f0b1faa-695e-4fed-af1c-b744052ed134" ],
    "device" : {
      "assetMAC" : "Asset MAC One",
      "batteryPercent" : 1,
      "platform" : "Platform One",
      "serialNumber" : 100000,
      "externalId" : "9ef6d6de-6126-45f5-996d-17295e52a2e1",
      "lastMovementTime" : "20210510160636",
      "lastReportTime" : "20210510160636",
      "lot" : 1,
      "panel" : 1,
      "part" : 1,
      "revision" : "Revision One",
      "status" : "requested"
    },
    "externalId" : "0891e451-2615-4756-9466-683ee5fc8d49",
    "facility" : "Facility One",
    "facilityId" : "a770fff0-bce5-4843-9211-487902ae3404",
    "firstName" : "First Name One",
    "flagged" : false,
    "lastEvent" : "Last Event One",
    "lastName" : "Last Name One",
    "latitude" : 43.071,
    "longitude" : -70.74515,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pcaKeyExpirationDate" : "202105111606",
    "pcaKeyId" : "afb1d203-bbc0-41c6-9114-601531ba5701",
    "postalCode" : "03801",
    "productTag" : "Product Tag One",
    "rev" : 1,
    "serialNumber" : 1000000,
    "state" : "NH",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "timeModified" : "20210510160636",
    "timeOfLog" : "20210510160636",
    "zone" : {
      "zoneId" : "9fd4cd90-fdba-45d8-af99-89cbadd095da",
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0,
      "binLocation" : "Bin One"
    },
    "assetId" : "e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e",
    "batchId" : "04e1ed35-6339-4f12-865e-168276c5306d",
    "currentOwnerId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d818eed9-30e5-48b4-8eae-167cc29ce583",
    "productId" : "c4557e95-668d-4651-bffc-bad92503971b",
    "images" : [ ],
    "timeOfLogLong" : 1620662796867,
    "timeCreatedLong" : 1620662796867,
    "timeModifiedString" : "05/10/2021",
    "timeOfLogSeconds" : 1620662796,
    "timeModifiedLong" : 1620662796867,
    "timeOfLogString" : "05/10/2021",
    "timeCreatedString" : "05/10/2021",
    "classificationItemMap" : { },
    "timeCreatedSeconds" : 1620662796,
    "timeModifiedSeconds" : 1620662796,
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Resigning assets

A GET request resigns an asset.

Example request parameters

Table 11. /lx-atlas/api/assets/{<assetId>}/reSign
Parameter Description

<assetId>

The asset id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/reSign' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:41 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 45
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "signature" : "",
  "success" : true
}

Fetching the QR Url

A GET request fetches the QR url for a specific asset by id.

Example request parameters

Table 12. /lx-atlas/api/assets/{<assetId>}/qrUrl
Parameter Description

<assetId>

The asset id.

urlBase

The optional base url portion of the QR url. Default is the app property url base: defaultUrlBaseShort

target

The optional target portion of the QR url. Default is the app property target: defaultUrlTarget

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/qrUrl?urlBase=api-dev.locatorx.com&target=qr-location' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:42 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 126
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "url" : "api-dev.locatorx.com/qr-location/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/?hash=QR Hash One"
}

Generating a QR Code

A GET request generates a QR code for a specific asset by id.

Example request parameters

Table 13. /lx-atlas/api/assets/{<assetId>}/qrCode
Parameter Description

<assetId>

The asset id.

urlBase

The optional base url portion of the QR url. Default is the app property url base: defaultUrlBaseShort

target

The optional target portion of the QR url. Default is the app property target: defaultUrlTarget

eccLevel

The optional ecc level. Default is L.

hideProductInfo

The optional hide product info. Default is false.

hideAssetInfo

The optional hide asset info. Default is false.

showTag

The optional show tag. Default is false.

magnification

The optional magnification. Default is 10.

version

The optional version. Default is 5.

tagFontSize

The optional tag font size. Default is 20.

environment

The optional environment.

qrBackground

The optional qr background.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/assets/e0b0d450-e3ac-4e4a-ae26-5d39d1fd432e/qrCode?urlBase=api-dev.locatorx.com&target=qr-location' -i -X GET \
    -H 'Accept: image/png' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response qr code

Batch Archives

The Batch Archives resource is used to list batch archives.

Listing batch archives

A GET request lists batch archives.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/batchTrashes' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:43 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 3645
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "batchTrashes" : [ {
    "appUserId" : "7efa9781-3f60-4301-98e8-9be6052efee8",
    "description" : "Description Two",
    "destinationLocation" : {
      "address1" : "379 New Castle Ave",
      "lat1000" : 43071,
      "lon1000" : -70745,
      "facility" : "Facility Name One",
      "facilityId" : "1bcf58d4-742c-490b-94de-13d640939839",
      "latitude" : 43.071,
      "longitude" : -70.74515,
      "city" : "Portsmouth",
      "state" : "NH",
      "country" : "US",
      "postalCode" : "03801",
      "xyz" : {
        "x" : 1.0,
        "y" : 1.0,
        "z" : 1.0
      },
      "description" : "Facility Name One"
    },
    "note" : "Note Two",
    "originLocation" : {
      "address1" : "25 Portland Ave",
      "lat1000" : 43197,
      "lon1000" : -70870,
      "facility" : "Facility Name Two",
      "facilityId" : "dbf48e77-fb07-4192-b13b-d069e871a39c",
      "latitude" : 43.19701,
      "longitude" : -70.87093,
      "city" : "Dover",
      "state" : "NH",
      "country" : "US",
      "postalCode" : "03820",
      "xyz" : {
        "x" : 2.0,
        "y" : 2.0,
        "z" : 2.0
      },
      "description" : "Facility Name Two"
    },
    "status" : "processing",
    "name" : "Name Two",
    "tag" : "Tag Two",
    "timeCreated" : "20210511160636",
    "url" : "URL Two",
    "numPending" : 1,
    "numProcessing" : 1,
    "numReady" : 1,
    "batchId" : "bfb51bb4-782d-4e62-a293-7bf05cc5c1ac",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "originString" : "Facility Name Two",
    "originLatitude" : 43.19701,
    "originLongitude" : -70.87093,
    "destinationString" : "Facility Name One",
    "propertiesMap" : {
      "Two-One" : "One",
      "Two-Three" : "Three",
      "Two-Two" : "Two"
    }
  }, {
    "appUserId" : "97c2b85c-3649-4440-a365-29ec7cdb9a4e",
    "description" : "Description One",
    "destinationLocation" : {
      "address1" : "379 New Castle Ave",
      "lat1000" : 43071,
      "lon1000" : -70745,
      "facility" : "Facility Name One",
      "facilityId" : "f93ea7b1-b024-4edd-9f66-928a03819c37",
      "latitude" : 43.071,
      "longitude" : -70.74515,
      "city" : "Portsmouth",
      "state" : "NH",
      "country" : "US",
      "postalCode" : "03801",
      "xyz" : {
        "x" : 1.0,
        "y" : 1.0,
        "z" : 1.0
      },
      "description" : "Facility Name One"
    },
    "note" : "Note One",
    "originLocation" : {
      "address1" : "25 Portland Ave",
      "lat1000" : 43197,
      "lon1000" : -70870,
      "facility" : "Facility Name Two",
      "facilityId" : "ad3847dd-58c8-4c31-a528-7d4c5bcc0542",
      "latitude" : 43.19701,
      "longitude" : -70.87093,
      "city" : "Dover",
      "state" : "NH",
      "country" : "US",
      "postalCode" : "03820",
      "xyz" : {
        "x" : 2.0,
        "y" : 2.0,
        "z" : 2.0
      },
      "description" : "Facility Name Two"
    },
    "status" : "pending",
    "name" : "Name One",
    "tag" : "Tag One",
    "timeCreated" : "20210510160636",
    "url" : "URL One",
    "numPending" : 1,
    "numProcessing" : 1,
    "numReady" : 1,
    "batchId" : "8b45389f-fc4a-42fe-bc4a-6ef92c50ee89",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "originString" : "Facility Name Two",
    "originLatitude" : 43.19701,
    "originLongitude" : -70.87093,
    "destinationString" : "Facility Name One",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  } ]
}

Classifications

The Classifications resource is used to create, modify and list classifications.

Listing classifications

A GET request lists classifications.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:44 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1088
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "classifications" : [ {
    "status" : "active",
    "name" : "Name Four",
    "classificationId" : "a883e003-ef70-44c6-bd23-4fd4d87c2537",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  }, {
    "status" : "active",
    "name" : "Name One",
    "classificationId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  } ],
  "classificationChildren" : {
    "a883e003-ef70-44c6-bd23-4fd4d87c2537" : [ ],
    "eda13dc1-69af-46c0-b5d7-d5d8f593e66f" : [ {
      "status" : "active",
      "name" : "Name Three",
      "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "classificationId" : "4a65020a-8b39-45a0-9995-f3cdf5cda720"
    }, {
      "status" : "active",
      "name" : "Name Two",
      "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "classificationId" : "82b2d101-0900-4a93-896c-04abd6befbda"
    } ]
  },
  "success" : true
}

Fetching classifications

A GET request fetches a specific classification by id.

Example request parameters

Table 14. /lx-atlas/api/classifications/{<classificationId>}
Parameter Description

<classificationId>

The classification id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications/eda13dc1-69af-46c0-b5d7-d5d8f593e66f' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:44 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 842
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "classificationChildren" : {
    "eda13dc1-69af-46c0-b5d7-d5d8f593e66f" : [ {
      "status" : "active",
      "name" : "Name Three",
      "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "classificationId" : "4a65020a-8b39-45a0-9995-f3cdf5cda720"
    }, {
      "status" : "active",
      "name" : "Name Two",
      "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
      "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
      "classificationId" : "82b2d101-0900-4a93-896c-04abd6befbda"
    } ]
  },
  "success" : true,
  "classification" : {
    "status" : "active",
    "name" : "Name One",
    "classificationId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  }
}

Listing classification children

A GET request lists all classification children for a parent classification id.

Request parameters definition

Table 15. /lx-atlas/api/classifications/childClassifications/{<parentId>}
Parameter Description

<parentId>

The parent classification id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications/childClassifications/eda13dc1-69af-46c0-b5d7-d5d8f593e66f' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:44 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 547
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "classifications" : [ {
    "status" : "active",
    "name" : "Name Three",
    "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "classificationId" : "4a65020a-8b39-45a0-9995-f3cdf5cda720"
  }, {
    "status" : "active",
    "name" : "Name Two",
    "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "classificationId" : "82b2d101-0900-4a93-896c-04abd6befbda"
  } ],
  "success" : true
}

Creating classifications

A POST request creates a new classification.

Request body definition

Path Type Description

name

String

The name of the classification.

organizationId

String

The optional organization id. Default is the organization of the user.

status

String

The optional status of the classification: active, inactive. Default is active.

parentId

String

The optional parent classification id. Default is no classification parent.

classificationChildren

Array

The optional list of classification children. Default is no children.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "classificationChildren" : [ {
    "status" : "active",
    "name" : "Name Two"
  }, {
    "status" : "active",
    "name" : "Name Three"
  } ],
  "status" : "active",
  "name" : "Name One"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:43 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 765
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "classificationChildren" : [ {
    "status" : "active",
    "name" : "Name Two",
    "classificationId" : "ecee0e0a-911a-4c58-9fb9-0f2a090ea7a3",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d43ba0dc-9bed-4d65-a582-a0b2568e73a7"
  }, {
    "status" : "active",
    "name" : "Name Three",
    "classificationId" : "ad9463de-9fa3-4bdd-aca6-a8f684fd28b3",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "d43ba0dc-9bed-4d65-a582-a0b2568e73a7"
  } ],
  "success" : true,
  "classification" : {
    "status" : "active",
    "name" : "Name One",
    "classificationId" : "d43ba0dc-9bed-4d65-a582-a0b2568e73a7",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  }
}

Creating classification children

A POST request creates a new classification child.

Request body definition

Path Type Description

name

String

The name of the child classification.

parentId

String

The parent classification id.

status

String

The optional status of the classification: active, inactive. Default is active.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "New Classification Child",
  "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:44 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 344
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "classificationChildren" : [ ],
  "success" : true,
  "classification" : {
    "status" : "active",
    "name" : "New Classification Child",
    "classificationId" : "39877988-5045-46a1-a07c-dfbfe192ea26",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "parentId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f"
  }
}

Updating classifications

A PUT request updates a classification.

Request parameters definition

Table 16. /lx-atlas/api/classifications/{<classificationId>}
Parameter Description

<classificationId>

The classification id.

Request body definition

Path Type Description

name

String

The optional name of the classification. Default is the name is not changed.

status

String

The optional status of the classification. DEefault is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/classifications/eda13dc1-69af-46c0-b5d7-d5d8f593e66f' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Classification Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:43 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 254
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "classification" : {
    "status" : "active",
    "name" : "Classification Name Changed",
    "classificationId" : "eda13dc1-69af-46c0-b5d7-d5d8f593e66f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  }
}

Connect Pages

The Connect Pages resource is used to create, modify, delete and list connect pages.

Listing connect pages

A GET request lists connect pages.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/connectPages' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:45 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 476
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "connectPages" : [ {
    "name" : "Name One",
    "connectPageId" : "d8942a80-cd4d-4e22-b6bc-88ea5eb82643",
    "configMap" : {
      "Connect Page One key 1" : "value 1",
      "Connect Page One key 2" : "value 2"
    }
  }, {
    "name" : "Name Two",
    "connectPageId" : "986215cc-afcc-479e-9198-2868bcc9d0f5",
    "configMap" : {
      "Connect Page Two key 1" : "value 1",
      "Connect Page Two key 2" : "value 2"
    }
  } ],
  "success" : true
}

Fetching connect pages

A GET request fetches a specific connect page by id.

Example request parameters

Table 17. /lx-atlas/api/connectPages/{<connectPageId>}
Parameter Description

<connectPageId>

The connect page id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/connectPages/d8942a80-cd4d-4e22-b6bc-88ea5eb82643' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:45 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 257
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "connectPage" : {
    "name" : "Name One",
    "connectPageId" : "d8942a80-cd4d-4e22-b6bc-88ea5eb82643",
    "configMap" : {
      "Connect Page One key 1" : "value 1",
      "Connect Page One key 2" : "value 2"
    }
  },
  "success" : true
}

Creating connect pages

A POST request creates a new connect page.

Request body definition

Path Type Description

name

String

The name of the connect page.

configMap

Object

The optional map of configurations.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/connectPages' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Name One",
  "configMap" : {
    "Connect Page One key 1" : "value 1",
    "Connect Page One key 2" : "value 2"
  }
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:45 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 257
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "connectPage" : {
    "name" : "Name One",
    "connectPageId" : "f481c02e-6899-401a-82dd-71335f2f47f4",
    "configMap" : {
      "Connect Page One key 1" : "value 1",
      "Connect Page One key 2" : "value 2"
    }
  },
  "success" : true
}

Updating connect pages

A PUT request updates an connect page.

Request parameters definition

Table 18. /lx-atlas/api/connectPages/{<connectPageId>}
Parameter Description

<connectPageId>

The connect page id.

Request body definition

Path Type Description

name

String

The name of the connect page.

configMap

Object

The optional map of configurations.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/connectPages/d8942a80-cd4d-4e22-b6bc-88ea5eb82643' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "ConnectPage Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:45 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 73
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "connectPage" : {
    "present" : true
  },
  "success" : true
}

Deleting connect pages

A DELETE request deletes an connect page.

Request parameters definition

Table 19. /lx-atlas/api/connectPages/{<connectPageId>}
Parameter Description

<connectPageId>

The connect page id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/connectPages/d8942a80-cd4d-4e22-b6bc-88ea5eb82643' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:45 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Event Triggers

The Event Triggers resource is used to create, modify, delete and list event triggers.

Listing event triggers

A GET request lists event triggers.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/eventTriggers' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:46 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1512
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "eventTriggers" : [ {
    "name" : "Name One",
    "note" : "Note One",
    "status" : "pending",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "eventTriggerId" : "18d367dd-5380-4110-8a57-db16d55fd4c3",
    "triggerMap" : {
      "productId" : "e53e3f12-8c2e-4fca-9f94-a75c24c7636c",
      "assetId" : "56f13f6e-681d-4251-896e-a5c14685bc15",
      "event" : "Event One",
      "batchId" : "7ad12e2f-142f-49b5-bf56-ba5e178434b2",
      "category" : "Category One"
    },
    "notificationMap" : {
      "email" : [ "59a5de4d-86f3-4e80-984d-bced129f3c38", "dfb839ee-3170-4094-b2f2-b2994565bf13" ]
    }
  }, {
    "name" : "Oyster Arrival",
    "status" : "pending",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "triggerMap" : {
      "repeat" : "all",
      "assetIds" : [ "745869ed-c480-4af9-9fad-b78316499288" ],
      "event" : "arrive"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "name" : "Oyster Arrival",
    "status" : "pending",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "eventTriggerId" : "9085c6e3-0431-4cd8-8bef-047a063c6d69",
    "triggerMap" : {
      "productId" : "3a638383-2e0c-490e-969d-5c92c9e110f9",
      "event" : "arrive"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  } ],
  "success" : true
}

Fetching event triggers

A GET request fetches a specific event trigger by id.

Example request parameters

Table 20. /lx-atlas/api/eventTriggers/{<eventTriggerId>}
Parameter Description

<eventTriggerId>

The event trigger id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/eventTriggers/18d367dd-5380-4110-8a57-db16d55fd4c3' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:46 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 667
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "eventTrigger" : {
    "name" : "Name One",
    "note" : "Note One",
    "status" : "pending",
    "eventTriggerId" : "18d367dd-5380-4110-8a57-db16d55fd4c3",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "triggerMap" : {
      "productId" : "e53e3f12-8c2e-4fca-9f94-a75c24c7636c",
      "assetId" : "56f13f6e-681d-4251-896e-a5c14685bc15",
      "event" : "Event One",
      "batchId" : "7ad12e2f-142f-49b5-bf56-ba5e178434b2",
      "category" : "Category One"
    },
    "notificationMap" : {
      "email" : [ "59a5de4d-86f3-4e80-984d-bced129f3c38", "dfb839ee-3170-4094-b2f2-b2994565bf13" ]
    }
  }
}

Creating event triggers

A POST request creates a new event trigger.

Request body definition

Path Type Description

name

String

The name of the event trigger.

organizationId

String

The optional organization id. Default is the organization of the user.

triggerMap

Object

The optional map of trigger information. If provided, this is merged with the current trigger map. Default is the trigger map is not changed.

triggerMap.event

String

The optional event. Used when creating the event condition.

triggerMap.assetIds

Array

The optional set of asset ids. Used when creating the event condition.

triggerMap.assetId

String

The optional asset id. Used when creating the event condition.

triggerMap.batchId

String

The optional batch id. Used when creating the event condition.

triggerMap.productId

String

The optional product id. Used when creating the event condition.

triggerMap.category

String

The optional category. Used when creating the event condition.

note

String

The optional note. Default is the note is not changed.

notificationMap

Object

The optional map of notifications. If provided, this is merged with the current notification map. Default is the notification map is not changed.

notificationMap.email

Array

The optional set of email ids.

status

String

The optional trigger status. Valid values are: pending, active, expired. Default is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/eventTriggers' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Name One",
  "note" : "Note One",
  "status" : "pending",
  "triggerMap" : {
    "productId" : "603463b9-370d-4b26-b405-ebf45cdbb483",
    "assetId" : "115c2f9d-29ea-4262-88cf-2e79b5562502",
    "event" : "Event One",
    "batchId" : "ad3e6b77-4cde-4bfc-969f-826b2a1b54d6",
    "category" : "Category One"
  },
  "notificationMap" : {
    "email" : [ "1178ba92-c5d1-4214-a113-76565f6868fc", "a4096128-d4c7-4a71-8e66-3b5606760cbb" ]
  }
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:46 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 667
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "eventTrigger" : {
    "name" : "Name One",
    "note" : "Note One",
    "status" : "pending",
    "eventTriggerId" : "2fde2c38-0d57-4d33-8631-ebf08cd90c20",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "triggerMap" : {
      "productId" : "603463b9-370d-4b26-b405-ebf45cdbb483",
      "assetId" : "115c2f9d-29ea-4262-88cf-2e79b5562502",
      "event" : "Event One",
      "batchId" : "ad3e6b77-4cde-4bfc-969f-826b2a1b54d6",
      "category" : "Category One"
    },
    "notificationMap" : {
      "email" : [ "1178ba92-c5d1-4214-a113-76565f6868fc", "a4096128-d4c7-4a71-8e66-3b5606760cbb" ]
    }
  }
}

Updating event triggers

A PUT request updates an event trigger.

Request parameters definition

Table 21. /lx-atlas/api/eventTriggers/{<eventTriggerId>}
Parameter Description

<eventTriggerId>

The event trigger id.

Request body definition

Path Type Description

name

String

The optional name of the event trigger. Default is the name is not changed.

organizationId

String

The optional organization id. Default is the organization of the user.

triggerMap

Object

The optional map of trigger information. If provided, this is merged with the current trigger map. Default is the trigger map is not changed.

triggerMap.event

String

The optional event. Used when creating the event condition.

triggerMap.assetIds

Array

The optional set of asset ids. Used when creating the event condition.

triggerMap.assetId

String

The optional asset id. Used when creating the event condition.

triggerMap.batchId

String

The optional batch id. Used when creating the event condition.

triggerMap.productId

String

The optional product id. Used when creating the event condition.

triggerMap.category

String

The optional category. Used when creating the event condition.

note

String

The optional note. Default is the note is not changed.

notificationMap

Object

The optional map of notifications. If provided, this is merged with the current notification map. Default is the notification map is not changed.

notificationMap.email

Array

The optional set of email ids.

status

String

The optional trigger status. Valid values are: pending, active, expired. Default is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/eventTriggers/18d367dd-5380-4110-8a57-db16d55fd4c3' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "EventTrigger Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:46 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 684
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "eventTrigger" : {
    "name" : "EventTrigger Name Changed",
    "note" : "Note One",
    "status" : "pending",
    "eventTriggerId" : "18d367dd-5380-4110-8a57-db16d55fd4c3",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "triggerMap" : {
      "productId" : "e53e3f12-8c2e-4fca-9f94-a75c24c7636c",
      "assetId" : "56f13f6e-681d-4251-896e-a5c14685bc15",
      "event" : "Event One",
      "batchId" : "7ad12e2f-142f-49b5-bf56-ba5e178434b2",
      "category" : "Category One"
    },
    "notificationMap" : {
      "email" : [ "59a5de4d-86f3-4e80-984d-bced129f3c38", "dfb839ee-3170-4094-b2f2-b2994565bf13" ]
    }
  }
}

Deleting event triggers

A DELETE request deletes an event trigger.

Request parameters definition

Table 22. /lx-atlas/api/eventTriggers/{<eventTriggerId>}
Parameter Description

<eventTriggerId>

The event trigger id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/eventTriggers/18d367dd-5380-4110-8a57-db16d55fd4c3' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Form Options

The Form Options resource is used to create, modify, delete and list form options.

Listing form options

A GET request lists form options.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1493
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOptions" : [ {
    "label" : "Form Option One",
    "fieldValue" : "Form Option One Value",
    "seq" : 1,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "bf1c44fd-7565-4a21-b4c3-6742b873b7c6"
  }, {
    "label" : "Green",
    "fieldValue" : "green",
    "seq" : 3,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "color",
    "formOptionId" : "00b1f419-eb02-4597-9919-480120fceeb4"
  }, {
    "label" : "Red",
    "fieldValue" : "red",
    "seq" : 2,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "color",
    "formOptionId" : "24163cb6-b8fc-4def-a22c-d15477322174"
  }, {
    "label" : "Blue",
    "fieldValue" : "blue",
    "seq" : 1,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "color",
    "formOptionId" : "5c1cfea8-b495-4b80-9333-f5e733adec87"
  }, {
    "label" : "Female",
    "fieldValue" : "female",
    "seq" : 2,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "gender",
    "formOptionId" : "3dbe46fb-eb4f-4a00-b55e-6d73b8d9f3f8"
  }, {
    "label" : "Male",
    "fieldValue" : "male",
    "seq" : 1,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "gender",
    "formOptionId" : "c42986ea-1cbc-453f-a2e7-4464132c86cc"
  } ],
  "success" : true
}

Listing form options by field option key

A GET request lists form options by a field option key.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions/key/Form%20Option%20One%20Key' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 597
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOptions" : [ {
    "label" : "Form Option Two",
    "fieldValue" : "Form Option Two Value",
    "seq" : 2,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "a2f3c76b-30a1-4b96-9c86-7c3119bb2a5e"
  }, {
    "label" : "Form Option One",
    "fieldValue" : "Form Option One Value",
    "seq" : 1,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "c5a2b3ff-5528-4a40-a9c4-c4eed0fe9ed1"
  } ],
  "success" : true
}

Fetching form options

A GET request fetches a specific form option by id.

Example request parameters

Table 23. /lx-atlas/api/formOptions/{<formOptionId>}
Parameter Description

<formOptionId>

The form option id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions/f215b21f-6370-44d6-bea4-62df0d9f2c91' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 317
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOption" : {
    "label" : "Form Option One",
    "fieldValue" : "Form Option One Value",
    "seq" : 1,
    "formOptionId" : "f215b21f-6370-44d6-bea4-62df0d9f2c91",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key"
  },
  "success" : true
}

Creating form options

A POST request creates a new form option.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization of the user.

fieldOptionKey

String

The form option key.

fieldValue

String

The form option field value.

label

String

The form option label.

seq

Number

The form option sequence.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "label" : "Form Option One",
  "fieldValue" : "Form Option One Value",
  "seq" : 1,
  "fieldOptionKey" : "Form Option One Key"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 317
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOption" : {
    "label" : "Form Option One",
    "fieldValue" : "Form Option One Value",
    "seq" : 1,
    "formOptionId" : "d7dd89d0-05c9-4a07-8406-6bdaabf517ef",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key"
  },
  "success" : true
}

Updating form options

A PUT request updates an form option.

Request parameters definition

Table 24. /lx-atlas/api/formOptions/{<formOptionId>}
Parameter Description

<formOptionId>

The form option id.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization of the user.

fieldOptionKey

String

The optional form option key. Default is the form option key is not changed.

fieldValue

String

The optional form option field value. Default is the field value is not changed.

label

String

The optional form option label. Default is the label is not changed.

seq

Number

The optional form option sequence. Default is the sequence is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions/7d7b4fa9-ef05-4cf6-8674-3b2824b3385b' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "label" : "FormOption Label Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 326
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOption" : {
    "label" : "FormOption Label Changed",
    "fieldValue" : "Form Option One Value",
    "seq" : 1,
    "formOptionId" : "7d7b4fa9-ef05-4cf6-8674-3b2824b3385b",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key"
  },
  "success" : true
}

Updating form options by field option key

A PUT request updates form options by field option key.

Request parameters definition

Table 25. /lx-atlas/api/formOptions/key/{<fieldOptionKey>}
Parameter Description

<fieldOptionKey>

The field option key.

Request body definition

Path Type Description

formOptions

Array

The list of form options to update. If the form options exist, it is updated. If the form option does not exist, it is added. All form options have their field option key set to <fieldOptionKey>.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions/key/Form%20Option%20One%20Key' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "formOptions" : [ {
    "label" : "New Form Option One Label",
    "fieldValue" : "New Form Option One Value",
    "formOptionId" : "ddfd7923-8bce-4b13-a59b-db1345e26eed"
  }, {
    "label" : "New Form Option Two Label",
    "fieldValue" : "New Form Option Two Value",
    "formOptionId" : "4c173644-5c3b-4a72-8a40-67bbdc50ba34"
  }, {
    "label" : "Added From Option Label",
    "fieldValue" : "Added Form Option Field Value",
    "seq" : 3
  } ]
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:48 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 916
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "formOptions" : [ {
    "label" : "Added From Option Label",
    "fieldValue" : "Added Form Option Field Value",
    "seq" : 3,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "0599ac83-1032-4536-8a74-41e663dffec4"
  }, {
    "label" : "New Form Option Two Label",
    "fieldValue" : "New Form Option Two Value",
    "seq" : 2,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "4c173644-5c3b-4a72-8a40-67bbdc50ba34"
  }, {
    "label" : "New Form Option One Label",
    "fieldValue" : "New Form Option One Value",
    "seq" : 1,
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fieldOptionKey" : "Form Option One Key",
    "formOptionId" : "ddfd7923-8bce-4b13-a59b-db1345e26eed"
  } ],
  "success" : true
}

Deleting form options

A DELETE request deletes an form option.

Request parameters definition

Table 26. /lx-atlas/api/formOptions/{<formOptionId>}
Parameter Description

<formOptionId>

The form option id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/formOptions/02f805b0-80c9-4c78-ab9a-3cc2d8848aec' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:47 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Forms

The Forms resource is used to create, modify, delete and list forms.

Listing forms

A GET request lists forms.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:48 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 2393
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "forms" : [ {
    "name" : "Topology",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "12cbc05d-9097-4b6e-812a-8ae5167263b9",
    "fields" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    }, {
      "fieldKey" : "note",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    }, {
      "fieldKey" : "note",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ]
  }, {
    "name" : "Edit Asset",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
    "fields" : [ {
      "fieldKey" : "note",
      "defaultValue" : "",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "note",
      "defaultValue" : "",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ]
  }, {
    "name" : "Form Two",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "a937c91e-916c-4a17-8f1b-22db74f2200a",
    "fields" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ]
  }, {
    "name" : "Form One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "b575197d-a903-470b-a658-11f68ac55543",
    "fields" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand"
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand"
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity"
    } ]
  } ]
}

Listing forms with details

A GET request lists forms with form options for matching form fields.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms/detail' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 3663
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "forms" : [ {
    "name" : "Topology",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "12cbc05d-9097-4b6e-812a-8ae5167263b9",
    "fields" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    }, {
      "fieldKey" : "note",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    }, {
      "fieldKey" : "note",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ]
  }, {
    "name" : "Edit Asset",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
    "fields" : [ {
      "fieldKey" : "note",
      "defaultValue" : "",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "note",
      "defaultValue" : "",
      "description" : "Enter a notation",
      "label" : "Notation",
      "fieldType" : "text"
    } ]
  }, {
    "name" : "Form Two",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "a937c91e-916c-4a17-8f1b-22db74f2200a",
    "fields" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ]
  }, {
    "name" : "Form One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "formId" : "b575197d-a903-470b-a658-11f68ac55543",
    "fields" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand",
      "formOptions" : [ {
        "label" : "Form Option One",
        "fieldValue" : "Form Option One Value",
        "seq" : 1,
        "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
        "fieldOptionKey" : "brand",
        "formOptionId" : "97f9a402-a2e3-48c7-b2e7-ceaa79c85385"
      } ]
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity",
      "formOptions" : [ {
        "label" : "Form Option Two",
        "fieldValue" : "Form Option Two Value",
        "seq" : 2,
        "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
        "fieldOptionKey" : "quantity",
        "formOptionId" : "15e48961-b808-46ef-aa45-4ea2365e4ddc"
      } ]
    } ],
    "fieldsList" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand",
      "formOptions" : [ {
        "label" : "Form Option One",
        "fieldValue" : "Form Option One Value",
        "seq" : 1,
        "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
        "fieldOptionKey" : "brand",
        "formOptionId" : "97f9a402-a2e3-48c7-b2e7-ceaa79c85385"
      } ]
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity",
      "formOptions" : [ {
        "label" : "Form Option Two",
        "fieldValue" : "Form Option Two Value",
        "seq" : 2,
        "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
        "fieldOptionKey" : "quantity",
        "formOptionId" : "15e48961-b808-46ef-aa45-4ea2365e4ddc"
      } ]
    } ]
  } ]
}

Fetching forms

A GET request fetches a specific form by id.

Example request parameters

Table 27. /lx-atlas/api/forms/{<formId>}
Parameter Description

<formId>

The form id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms/b575197d-a903-470b-a658-11f68ac55543' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:48 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 883
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "form" : {
    "name" : "Form One",
    "formId" : "b575197d-a903-470b-a658-11f68ac55543",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fields" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand",
      "formOptions" : [ ]
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity",
      "formOptions" : [ ]
    } ],
    "fieldsList" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand",
      "formOptions" : [ ]
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity",
      "formOptions" : [ ]
    } ]
  },
  "success" : true
}

Creating forms

A POST request creates a new form.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The name of the form.

fields

Array

The fields array.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Form One",
  "fields" : [ {
    "fieldKey" : "assets",
    "label" : "Assets",
    "fieldType" : "scannedAssets"
  } ]
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:48 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 441
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "form" : {
    "name" : "Form One",
    "formId" : "133f4b53-9cef-47c5-aa72-9e0784b831c6",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fields" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "assets",
      "label" : "Assets",
      "fieldType" : "scannedAssets"
    } ]
  },
  "success" : true
}

Updating forms

A PUT request updates a form.

Request parameters definition

Table 28. /lx-atlas/api/forms/{<formId>}
Parameter Description

<formId>

The form id.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The name of the form. Default is the name is not changed.

fields

Array

The optional fields array.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms/b575197d-a903-470b-a658-11f68ac55543' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Form Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 780
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "form" : {
    "name" : "Form Name Changed",
    "formId" : "b575197d-a903-470b-a658-11f68ac55543",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "fields" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand"
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity"
    } ],
    "fieldsList" : [ {
      "fieldKey" : "brand",
      "label" : "Brand",
      "fieldType" : "select",
      "fieldOptionKey" : "brand"
    }, {
      "fieldKey" : "quantity",
      "label" : "Quantity",
      "fieldType" : "select",
      "fieldOptionKey" : "quantity"
    } ]
  },
  "success" : true
}

Deleting forms

A DELETE request deletes a form.

Request parameters definition

Table 29. /lx-atlas/api/forms/{<formId>}
Parameter Description

<formId>

The form id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/forms/b575197d-a903-470b-a658-11f68ac55543' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:48 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Notifications

The Notifications resource is used to list notifications.

Listing notifications

A GET request lists notifications.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/notifications' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 14667
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "notifications" : [ {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "a6a39599-0f28-4215-b485-36e1f5ec9a88",
    "timeAdded" : "20200530120000",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "00c046ad-eea4-41dd-a711-19ad66e28a1d"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "0338032d-e499-4332-b057-a5e9b3162452"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "05a1976f-48bd-4da9-aafb-7359a9a1392b"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "05ff2bba-4f34-442c-bf21-c35b26221bc6"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "06450aa7-e0d0-46cf-af87-df7aa632611e"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "0b3198c3-4b76-43a1-812f-903fef935256"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "0d7c410f-3baa-4788-b02d-f8db3c08db00"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "1924bcf0-7d2e-4d33-a5c0-209d53221e3f"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "02821f92-cc78-40f0-9796-f5668bf433ee",
    "timeAdded" : "20200529163117",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "21db65fd-f4b6-484d-8869-bbf400338b54"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "224a2fbb-abe1-4372-b3e7-1ee6267c6762"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "2909824c-907b-4716-93c3-47b9a9b582fe"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "34125b42-c84b-449c-b800-cd5660908a15"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "35374454-e0d4-4391-93ce-0dac9d084d26"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "timeAdded" : "20200604112400",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "35b2cc1e-46b1-42ce-93d2-87d42207d26f"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "390e0c18-d638-462b-9793-7a30ab094719"
  }, {
    "appUserIds" : [ "60d75e50-c64a-490b-a6f1-7252c42c993f", "9b8eeb0e-8227-4599-ba13-6f55f929de29" ],
    "eventTriggerId" : "e49404f7-4ea2-40d8-a23d-e05ff0b3ad79",
    "reportTriggerId" : "d2001c6a-57d1-4157-936e-c0be0f1b273f",
    "timeAdded" : "20210511160636",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "3e3d9d66-9f90-4818-a4e1-7990eb0c0c12"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "9085c6e3-0431-4cd8-8bef-047a063c6d69",
    "timeAdded" : "20200529163433",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "5732dda8-f664-4468-91c7-4c56226d2624"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "6506ee30-53c6-4cb6-8b97-90cd64b088c6"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "570e74eb-97f1-4e73-afd0-643500f0bc81",
    "timeAdded" : "20200915134951",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "658871ad-baf7-477f-86ee-da3cf8934635"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "66cef966-f444-4b5d-a0a8-18f45d587c78"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "67c6c7a5-3c4d-494e-b4f2-58fcea7441c0"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "6921b441-8f7d-4682-9cfc-2dbb15898b1e"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "timeAdded" : "20200530132800",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "71c9d636-a424-4553-b8c8-0395354466a6"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "7e0e101b-806c-49b9-8320-9ebdfba46043"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "7fe52e80-932b-48c3-b739-fd70bf49cb7b"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "83e2eed3-8c54-4384-be73-b60a3e158ace"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200529163433",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "85841db6-2346-45b9-956b-fa3977d6bf84"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "8952e8c9-d21c-438b-8231-31345b0838ab"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "a6a39599-0f28-4215-b485-36e1f5ec9a88",
    "timeAdded" : "20200531120000",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "8e74dfe5-41ef-4402-a74d-f603452b8b40"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "90fd4c77-5136-40f0-9a0a-a78a2e7676c0"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "2b5fce1c-cec1-479e-898e-5e6d57f8ef1b",
    "timeAdded" : "20200530131000",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "92c9f813-ee1c-4b38-8e15-b1629ce8b94b"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "93e47646-226b-4693-a4ee-6b0f3ea41306"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "timeAdded" : "20200603112400",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "ab15abee-a2a1-45ea-bd62-b58399e908c3"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200605123040",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "ab2159af-0297-40d7-998b-fd4f43a383f4"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "ae994586-b243-4b3e-aada-83ad450e57d6"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "00602a21-9b8a-45f7-ba28-219848f8938f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "b22600f1-3bf2-47f7-bbcd-aeff7e6c27dd"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "b5641a44-cc82-41db-a678-d39a26dbe12d"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "timeAdded" : "20200531132800",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "b5b92495-cd3f-48a3-b1af-4b22374dccf4"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200609144721",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "c906fb9d-cab5-4a8c-bbf7-269f9d2be11d"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "cbcb54d0-cd51-42b0-a060-08f4dfc435cf"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "ce0315db-0d9c-4944-974d-378ef243d8a5"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "d1cca265-894d-4f32-8ccd-a58ea775f0b6"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200529163455",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "d73a7a65-c7e7-456b-917b-1d2d2cc140a1"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "2b5fce1c-cec1-479e-898e-5e6d57f8ef1b",
    "timeAdded" : "20200531131000",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "d9d2f634-8e3d-4b82-924b-9370e0aaf97e"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "df339a22-c84a-4a84-bdbf-1986e57c163c"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "e2ee30d4-f7f3-424e-af25-7c719a6a6963"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200605123302",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "e465a9f9-4a89-4b08-ab7b-f74cdd806c47"
  }, {
    "appUserIds" : [ "a011e659-9bbc-42b5-a758-6edefc258ef4", "b7645cc7-86e7-489a-b002-33324788d863" ],
    "eventTriggerId" : "f4ebc531-cf74-4912-b385-235be6fa93f2",
    "reportTriggerId" : "f3ddb019-8b7e-43c3-ac04-7b4f135965ea",
    "timeAdded" : "20210510160636",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "f675dce8-13a7-4fb0-8bcb-bbbec3ce48d4"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "f75c4180-1b78-4f58-bc8a-8df15e47817f"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "fdc018a0-0b26-4ca6-ae49-980cc8121eeb"
  }, {
    "appUserIds" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ],
    "eventTriggerId" : "2f227503-376b-4439-bf96-2fbe77a88d5f",
    "timeAdded" : "20200618131318",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "notificationId" : "ffa3e039-ab15-4e48-8111-78dca6fd953e"
  } ]
}

Fetching notifications

A GET request fetches a specific notification by id.

Example request parameters

Table 30. /lx-atlas/api/notifications/{<notificationId>}
Parameter Description

<notificationId>

The notification id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/notifications/f675dce8-13a7-4fb0-8bcb-bbbec3ce48d4' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 449
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "notification" : {
    "appUserIds" : [ "a011e659-9bbc-42b5-a758-6edefc258ef4", "b7645cc7-86e7-489a-b002-33324788d863" ],
    "eventTriggerId" : "f4ebc531-cf74-4912-b385-235be6fa93f2",
    "reportTriggerId" : "f3ddb019-8b7e-43c3-ac04-7b4f135965ea",
    "timeAdded" : "20210510160636",
    "notificationId" : "f675dce8-13a7-4fb0-8bcb-bbbec3ce48d4",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1"
  },
  "success" : true
}

Platforms

The Platforms resource is used to create, modify, delete and list platforms.

Listing platforms

A GET request lists platforms.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/platforms' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 615
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "platforms" : [ {
    "lastLot" : 1,
    "latestFirmware" : "Firmware One",
    "latestRevision" : "20210510",
    "structAddr" : "AAAAAAAA",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "name" : "Name One",
    "platformId" : "49a96469-23a1-4fa1-bb70-77412f6b607a"
  }, {
    "lastLot" : 2,
    "latestFirmware" : "Firmware Two",
    "latestRevision" : "20210509",
    "structAddr" : "BBBBBBBB",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "name" : "Name Two",
    "platformId" : "90cc258e-50af-43b7-9e27-534e4ecd5dc9"
  } ]
}

Fetching platforms

A GET request fetches a specific platform by id.

Example request parameters

Table 31. /lx-atlas/api/platforms/{<platformId>}
Parameter Description

<platformId>

The platform id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/platforms/49a96469-23a1-4fa1-bb70-77412f6b607a' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:49 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 325
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "platform" : {
    "lastLot" : 1,
    "latestFirmware" : "Firmware One",
    "latestRevision" : "20210510",
    "structAddr" : "AAAAAAAA",
    "platformId" : "49a96469-23a1-4fa1-bb70-77412f6b607a",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "name" : "Name One"
  }
}

Creating platforms

A POST request creates a new platform.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The name of the platform.

latestRevision

String

The latest revision date. The date format is yyyyMMdd.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/platforms' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "latestRevision" : "20210506",
  "name" : "Name One"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 233
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "platform" : {
    "latestRevision" : "20210506",
    "platformId" : "cfde8bf3-55b6-40f4-ab1f-09e10694606f",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "name" : "Name One"
  }
}

Updating platforms

A PUT request updates a platform.

Request parameters definition

Table 32. /lx-atlas/api/platforms/{<platformId>}
Parameter Description

<platformId>

The platform id.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The optional name of the platform. Default is the name is not changed.

latestRevision

String

The optional latest revision date. The date format is yyyyMMdd. Default is the latest revision is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/platforms/49a96469-23a1-4fa1-bb70-77412f6b607a' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Platform Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 338
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "platform" : {
    "lastLot" : 1,
    "latestFirmware" : "Firmware One",
    "latestRevision" : "20210510",
    "structAddr" : "AAAAAAAA",
    "platformId" : "49a96469-23a1-4fa1-bb70-77412f6b607a",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "name" : "Platform Name Changed"
  }
}

Deleting platforms

A DELETE request deletes a platform.

Request parameters definition

Table 33. /lx-atlas/api/platforms/{<platformId>}
Parameter Description

<platformId>

The platform id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/platforms/49a96469-23a1-4fa1-bb70-77412f6b607a' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Radios

The Radios resource is used to modify and list radios.

Listing radios

A POST request lists radios.

Request parameters definition

Table 34. /lx-atlas/api/radios/csm/{<csm>}
Parameter Description

<csm>

The csm type. Valid values are: admin, console, mobile.

Request body definition

Path Type Description

csmToken

String

The optional csm token. This can be used in place of the CSM header token.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/radios/csm/admin' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'CSM: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{ }'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 1109
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "radios" : [ {
    "facilityId" : "6e225d12-1e4f-4395-9e60-be4e3c72ac19",
    "isNumbersStation" : true,
    "node" : "Node Two",
    "note" : "Note Two",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pZoneSequence" : 2,
    "primaryPZoneId" : "b6fea310-9a4a-4324-a4fa-bffd88410b18",
    "secondaryPZoneId" : "146ddeba-18a9-4bb6-84ce-d69424400f35",
    "xyz" : {
      "x" : 2.0,
      "y" : 2.0,
      "z" : 2.0
    },
    "tlZoneId" : "7ed3407f-3d16-4395-9766-beef72129a2a",
    "radio" : "Radio Two"
  }, {
    "facilityId" : "3fbfd1ab-faf4-4d81-a3a1-7b0cb3df2635",
    "isNumbersStation" : false,
    "node" : "Node One",
    "note" : "Note One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pZoneSequence" : 1,
    "primaryPZoneId" : "07f0a0ae-9249-461b-9e0d-b4fe1d193914",
    "secondaryPZoneId" : "dcb12714-510e-4d32-a1f3-a3365d129c82",
    "xyz" : {
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0
    },
    "tlZoneId" : "b4797a73-a976-423a-8af6-a029de596d57",
    "radio" : "Radio One"
  } ],
  "success" : true
}

Fetching radios

A POST request fetches a specific radio by id.

Request parameters definition

Table 35. /lx-atlas/api/radios/csm/{<csm>}/{<radioId>}
Parameter Description

<csm>

The csm type. Valid values are: admin, console, mobile.

<radioId>

The radio. This is the MAC address of the radio.

Request body definition

Path Type Description

csmToken

String

The optional csm token. This can be used in place of the CSM header token.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/radios/csm/admin/Radio%20One' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'CSM: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{ }'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 571
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "radio" : {
    "facilityId" : "3fbfd1ab-faf4-4d81-a3a1-7b0cb3df2635",
    "isNumbersStation" : false,
    "node" : "Node One",
    "note" : "Note One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pZoneSequence" : 1,
    "primaryPZoneId" : "07f0a0ae-9249-461b-9e0d-b4fe1d193914",
    "secondaryPZoneId" : "dcb12714-510e-4d32-a1f3-a3365d129c82",
    "xyz" : {
      "x" : 1.0,
      "y" : 1.0,
      "z" : 1.0
    },
    "tlZoneId" : "b4797a73-a976-423a-8af6-a029de596d57",
    "radio" : "Radio One"
  }
}

Updating radios

A PUT request updates a radio.

Request parameters definition

Table 36. /lx-atlas/api/radios/csm/{<csm>}/{<radioId>}
Parameter Description

<csm>

The csm type. Valid values are: admin, console, mobile.

<radioId>

The radio. This is the MAC address of the radio.

Request body definition

Path Type Description

csmToken

String

The optional csm token. This can be used in place of the CSM header token.

organizationId

String

The optional organization id. Default is the organization of the user.

facilityId

String

The optional facility id. Default is the facility id is not changed.

isNumbersStation

Boolean

The optional numbver station flag. Default is the number station flag is not changed.

node

String

The optional node. Default is the is node not changed.

note

String

The optional note. Default is the note is not changed.

pZoneSequence

Number

The optional zone sequence. Default is the sequence is not changed.

primaryPZoneId

String

The optional primary pzone id. Default is the primary pzone id is not changed.

secondaryPZoneId

String

The optional secondary pzone id. Default is the secondary pzone id is not changed.

zoneId

String

The optional zone id. This can be used in place of tlZoneId. Default is the tl zone id is not changed.

tlZoneId

String

The optional tl zone id. If present, the radio facility and organization are set based on the zone. Default is the tl zone id is not changed.

xyz

Object

The optional zyx coordinates. Default is the coordinates are not changed.

xyz.x

Number

The x coordinate.

xyz.y

Number

The y coordinate.

xyz.z

Number

The z coordinate.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/radios/csm/admin/Radio%20One' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'CSM: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "facilityId" : "7cf2841c-8bb2-4cef-9d0a-e5e13459aea0",
  "isNumbersStation" : true,
  "node" : "Node Two",
  "note" : "Note Two",
  "pZoneSequence" : 1,
  "primaryPZoneId" : "ee631e23-de57-4879-abeb-2c7ddcf7d771",
  "secondaryPZoneId" : "19f707cf-b300-4a91-bdaf-f3dbb246261f",
  "xyz" : {
    "x" : 2.0,
    "y" : 2.0,
    "z" : 2.0
  },
  "zoneId" : "f2433154-aeb8-4d05-ba30-8f8f478fbca3"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:50 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 570
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "radio" : {
    "facilityId" : "7cf2841c-8bb2-4cef-9d0a-e5e13459aea0",
    "isNumbersStation" : true,
    "node" : "Node Two",
    "note" : "Note Two",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "pZoneSequence" : 1,
    "primaryPZoneId" : "ee631e23-de57-4879-abeb-2c7ddcf7d771",
    "secondaryPZoneId" : "19f707cf-b300-4a91-bdaf-f3dbb246261f",
    "xyz" : {
      "x" : 2.0,
      "y" : 2.0,
      "z" : 2.0
    },
    "tlZoneId" : "f2433154-aeb8-4d05-ba30-8f8f478fbca3",
    "radio" : "Radio One"
  }
}

Report Triggers

The Report Triggers resource is used to create, modify, delete and list report triggers.

Listing report triggers

A GET request lists report triggers.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/reportTriggers' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:51 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 3852
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "reportTriggers" : [ {
    "nextTime" : "202007011310",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "282cc14b-97b9-4b98-a167-6d7d84393c26",
    "status" : "expired",
    "scheduleMap" : {
      "monthly" : {
        "dayOfMonth" : 1,
        "timeOfDay" : "13:10"
      },
      "start" : "202005271200",
      "end" : "202006031200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "nextTime" : "202006041310",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "2b5fce1c-cec1-479e-898e-5e6d57f8ef1b",
    "status" : "expired",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "13:10"
      },
      "start" : "202005271200",
      "end" : "202006031200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "name" : "Name Two",
    "nextTime" : "202105111606",
    "note" : "Note Two",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "335473d8-648b-4b4c-86f2-e33c47a7d719",
    "status" : "pending",
    "scheduleMap" : {
      "monthly" : {
        "dayOfMonth" : 1,
        "timeOfDay" : "13:10"
      },
      "start" : "202005271200",
      "end" : "202006031200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15e" ]
    }
  }, {
    "nextTime" : "202006151200",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "53114ef6-5388-406e-a283-1c4278a401a2",
    "status" : "expired",
    "scheduleMap" : {
      "start" : "202005271200",
      "end" : "202006031200",
      "weekly" : {
        "dayOfWeek" : "Mon",
        "timeOfDay" : "12:00"
      }
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "nextTime" : "202005301352",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "9f6a41eb-46f1-48c1-9804-60d6d25eb977",
    "status" : "expired",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "13:52"
      },
      "start" : "202005271200",
      "end" : "202005301200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "nextTime" : "202006041200",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "a6a39599-0f28-4215-b485-36e1f5ec9a88",
    "status" : "expired",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "12:00"
      },
      "start" : "202005271200",
      "end" : "202006031200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  }, {
    "name" : "Name One",
    "nextTime" : "202105101606",
    "note" : "Note One",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "d98f7cb4-2337-4544-a321-7b23fa7f3e7a",
    "status" : "active",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "11:24"
      },
      "start" : "202005271200",
      "end" : "202006071200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d", "73ef5f79-88ef-4a63-86fe-89cd19a7e15e" ]
    }
  }, {
    "nextTime" : "202006051124",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "reportTriggerId" : "f9cb330f-3896-485b-b5b5-00ce142c3d3d",
    "status" : "scheduled",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "11:24"
      },
      "start" : "202005271200",
      "end" : "202006071200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d" ]
    }
  } ],
  "success" : true
}

Fetching report triggers

A GET request fetches a specific report trigger by id.

Example request parameters

Table 37. /lx-atlas/api/reportTriggers/{<reportTriggerId>}
Parameter Description

<reportTriggerId>

The report trigger id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/reportTriggers/d98f7cb4-2337-4544-a321-7b23fa7f3e7a' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:51 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 75
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "reportTrigger" : {
    "present" : true
  }
}

Creating report triggers

A POST request creates a new report trigger.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The name of the report trigger. Default is the name is not changed.

scheduleMap

Object

The map that defines the report trigger schedule. Default is the schedule is not changed.

note

String

The optional note. Default is the note is not changed.

notificationMap

Object

The optional notifications. This is an arrray of user ids to send the notification. Default is the notifications are not changed.

status

String

The optional status. Valid values are: pending, scheduled, active, expired. Default is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/reportTriggers' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "Report Trigger One",
  "note" : "Note One",
  "status" : "active",
  "scheduleMap" : {
    "daily" : {
      "timeOfDay" : "11:24"
    },
    "start" : "202005271200",
    "end" : "202006071200"
  },
  "notificationMap" : {
    "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d", "73ef5f79-88ef-4a63-86fe-89cd19a7e15e" ]
  }
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:51 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 559
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "reportTrigger" : {
    "name" : "Report Trigger One",
    "note" : "Note One",
    "reportTriggerId" : "47ee264c-dc8c-481a-af65-234a33a11923",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "status" : "pending",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "11:24"
      },
      "start" : "202005271200",
      "end" : "202006071200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d", "73ef5f79-88ef-4a63-86fe-89cd19a7e15e" ]
    }
  }
}

Updating report triggers

A PUT request updates a report trigger.

Request parameters definition

Table 38. /lx-atlas/api/reportTriggers/{<reportTriggerId>}
Parameter Description

<reportTriggerId>

The report trigger id.

Request body definition

Path Type Description

organizationId

String

The optional organization id. Default is the organization id is not changed.

name

String

The optional name of the report trigger. Default is the name is not changed.

scheduleMap

Object

The optional map that defines the report trigger schedule. Default is the schedule is not changed.

note

String

The optional note. Default is the note is not changed.

notificationMap

Object

The optional notifications. This is an arrray of user ids to send the notification. Default is the notifications are not changed.

status

String

The optional status. Valid values are: pending, scheduled, active, expired. Default is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/reportTriggers/d98f7cb4-2337-4544-a321-7b23fa7f3e7a' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "name" : "ReportTrigger Name Changed"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:52 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 600
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "reportTrigger" : {
    "name" : "ReportTrigger Name Changed",
    "nextTime" : "202105101606",
    "note" : "Note One",
    "reportTriggerId" : "d98f7cb4-2337-4544-a321-7b23fa7f3e7a",
    "organizationId" : "35c1f09f-9768-4a2e-8906-cf1c8fce40c1",
    "status" : "active",
    "scheduleMap" : {
      "daily" : {
        "timeOfDay" : "11:24"
      },
      "start" : "202005271200",
      "end" : "202006071200"
    },
    "notificationMap" : {
      "email" : [ "83ef5f79-88ef-4a63-86fe-89cd19a7e15d", "73ef5f79-88ef-4a63-86fe-89cd19a7e15e" ]
    }
  }
}

Deleting report triggers

A DELETE request deletes a report trigger.

Request parameters definition

Table 39. /lx-atlas/api/reportTriggers/{<reportTriggerId>}
Parameter Description

<reportTriggerId>

The report trigger id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/reportTriggers/d98f7cb4-2337-4544-a321-7b23fa7f3e7a' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:51 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 24
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true
}

Telemetry

The Telemetry resource is used to poll and list telemetry data as well as reserve timeslots.

A POST request lists telemetry data.

Request parameters definition

Table 40. /lx-atlas/api/telemetry/csm/{<csm>}/search
Parameter Description

<csm>

The csm type. Valid values are: admin, console, mobile.

Request body definition

Path Type Description

csmToken

String

The optional csm token. This can be used in place of the CSM header token.

solrQuery

Object

The solr query to use for searching.

limit

Number

The optional limit. This limits the number of results returned to at most limit.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/telemetry/csm/admin/search' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'CSM: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "solrQuery" : {
    "q" : "*:*"
  },
  "limit" : 2
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:52 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 57
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "count" : 0,
  "logs" : [ ]
}

Poll NTS

A POST request polls nts.

Request parameters definition

Table 41. /lx-atlas/api/telemetry/csm/{<csm>}/pollNTS
Parameter Description

<csm>

The csm type. Valid values are: admin, console, mobile.

Request body definition

Path Type Description

csmToken

String

The optional csm token. This can be used in place of the CSM header token.

pZoneId

String

The zone id to poll for.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/telemetry/csm/admin/pollNTS' -i -X POST \
    -H 'Accept: text/plain' \
    -H 'CSM: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "pZoneId" : "f2433154-aeb8-4d05-ba30-8f8f478fbca3"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:52 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: text/plain;charset=UTF-8
Content-Length: 30
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

<nts/Asset MAC 1/1/RTC 1/1/1/>

Reserve Timeslot

A POST request reserves a timeslot.

Request parameters definition

Table 42. /lx-atlas/api/telemetry/reserveTimeslot/{<timeslot>}
Parameter Description

<timeslot>

The timeslot to use as the basis.

Request body definition

Path Type Description

assetId

String

The asset id to use.

zoneId

String

The zone id to use.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/telemetry/reserveTimeslot/-1' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "assetId" : "da46353e-6941-4b4e-8364-d3d05324969e",
  "zoneId" : "e6a142cd-2693-4606-b5e8-2217133663a9"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:53 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 201
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "timeslot" : {
    "channel" : 1,
    "zoneId" : "e6a142cd-2693-4606-b5e8-2217133663a9",
    "assetId" : "da46353e-6941-4b4e-8364-d3d05324969e",
    "timeslot" : 1
  }
}

User Notifications

The User Notifications resource is used to modify and list user notifications.

Listing user notifications

A GET request lists user notifications.

Request parameters definition

Table 43. /lx-atlas/api/userNotifications/appUsers/{<appUserId>}
Parameter Description

<appUserId>

The app user id to get the user notifcations for.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/userNotifications/appUsers/0b4bddff-cc98-4004-a03c-24c50ba395d7' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:53 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 744
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "userNotifications" : [ {
    "status" : "pending",
    "timeSent" : "20210510160736",
    "timeRead" : "20210510160836",
    "appUserId" : "0b4bddff-cc98-4004-a03c-24c50ba395d7",
    "userNotificationId" : "00dca8f5-edd8-43fa-9c27-340a36977261",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }, {
    "status" : "read",
    "timeSent" : "20210510160936",
    "timeRead" : "20210510161036",
    "appUserId" : "0b4bddff-cc98-4004-a03c-24c50ba395d7",
    "userNotificationId" : "d27c3833-be2a-4d93-aa98-072b9158771d",
    "propertiesMap" : {
      "Two-One" : "One",
      "Two-Three" : "Three",
      "Two-Two" : "Two"
    }
  } ]
}

Fetching user notifications

A GET request fetches a specific user notification by id.

Request parameters definition

Table 44. /lx-atlas/api/userNotifications/{<userNotificationId>}
Parameter Description

<userNotificationId>

The user notification id.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/userNotifications/00dca8f5-edd8-43fa-9c27-340a36977261' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:53 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 395
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "userNotification" : {
    "status" : "pending",
    "timeSent" : "20210510160736",
    "timeRead" : "20210510160836",
    "userNotificationId" : "00dca8f5-edd8-43fa-9c27-340a36977261",
    "appUserId" : "0b4bddff-cc98-4004-a03c-24c50ba395d7",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}

Updating user notifications

A PUT request updates a user notification.

Request parameters definition

Table 45. /lx-atlas/api/userNotifications/{<userNotificationId>}
Parameter Description

<userNotificationId>

The user notification id.

Request body definition

Path Type Description

appUserId

String

The optional app user id. Default is the app user id is not changed.

status

String

The optional status. Valid values are: pending, sent, read, dismissed. Default is the status is not changed.

Example request

$ curl 'https://api-dev.locatorx.com/lx-atlas/api/userNotifications/00dca8f5-edd8-43fa-9c27-340a36977261' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Auth-Token: 9f74701a-ca5c-4669-957b-eafefcc88a63' \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{
  "appUserId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2"
}'

Example response

HTTP/1.1 200 OK
Access-Control-Allow-Headers: origin, content-type, accept, authorization, Auth-Token
Date: Mon, 10 May 2021 16:06:53 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Content-Type: application/json
Content-Length: 395
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS, HEAD
Access-Control-Max-Age: 1209600

{
  "success" : true,
  "userNotification" : {
    "status" : "pending",
    "timeSent" : "20210510160736",
    "timeRead" : "20210510160836",
    "userNotificationId" : "00dca8f5-edd8-43fa-9c27-340a36977261",
    "appUserId" : "89e6cfc3-41e6-4311-861c-12cfd9cbc9e2",
    "propertiesMap" : {
      "One-Three" : "Three",
      "One-One" : "One",
      "One-Two" : "Two"
    }
  }
}