SiteSense API API Reference

SiteSense® provides a powerful 3rd Party RESTful API which can be used to integrate SiteSense® with other systems such as ERP, BIM, project management, engineering design tools or other business systems.

API Endpoint
https://api.sitesenseweb.com/{environment}/{path}
Schemes: https
Version: 4.1

Authentication

api_key

name
x-api-key
in
header

JWT-Authorizer

name
Authorization
in
header
x-amazon-apigateway-authtype
custom
x-amazon-apigateway-authorizer
[object Object]

Material Management

API related to Material Management

Create Part

POST /parts

It is used to create new parts in SiteSense®

Request Content-Types: application/json
Request Example
{
  "resources": [
    {
      "name": "string",
      "description": "string",
      "uom": "string",
      "commodity": "boolean",
      "resourceTypeID": "integer",
      "schemaID": "integer",
      "propertyNames": "string",
      "propertyValues": "string",
      "projectID": "integer"
    }
  ]
}
200 OK

200 response

400 Bad Request

400 response

Response Content-Types: application/json
Response Example (200 OK)
{
  "date": "string",
  "report": "string",
  "guid": "string"
}
Response Example (400 Bad Request)
{
  "date": "string",
  "report": "string",
  "guid": "string"
}

Create Purchase Order

POST /reference-document/purchase-order

It is used to create new purchase orders in SiteSense®

Request Content-Types: application/json
Request Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "poName": "string",
      "poDescription": "string",
      "poItemLineNumber": "string",
      "poItemSubLineNumber": "integer",
      "poItemName": "string",
      "poItemDescription": "string",
      "poItemQuantity": "string",
      "poItemUOM": "string",
      "poItemResourceTypeID": "integer",
      "poItemExecutionDate": "string",
      "poItemParameter": "string",
      "poItemParameterValues": "string",
      "poParameter": "string",
      "poParameterValues": "string",
      "poLocked": "boolean"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Create Shipment

POST /reference-document/shipment

It is used to create new shipments in SiteSense®

Request Content-Types: application/json
Request Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "shipmentName": "string",
      "shipmentDescription": "string",
      "shipmentItemLineNumber": "string",
      "shipmentItemSubLineNumber": "integer",
      "shipmentItemName": "string",
      "shipmentItemQuantity": "string",
      "shipmentItemUOM": "string",
      "shipmentItemResourceTypeID": "integer",
      "shipmentItemExecutionDate": "string",
      "shipmentItemParameter": "string",
      "shipmentItemParameterValues": "string",
      "shipmentParameter": "string",
      "shipmentParameterValues": "string",
      "shipmentItemFromRefDoc": "string",
      "shipmentItemFromRefDocLineNumber": "string",
      "shipmentLocked": "boolean"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Create Receipt

POST /reference-document/receipt

It is used to create new receipts in SiteSense®

Request Content-Types: application/json
Request Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "receiveName": "string",
      "receiveDescription": "string",
      "receiveItemLineNumber": "string",
      "receiveItemSubLineNumber": "string",
      "receiveItemName": "string",
      "receiveItemQuantity": "string",
      "receiveItemUOM": "string",
      "receiveItemResourceTypeID": "integer",
      "receiveItemExecutionDate": "string",
      "receiveItemParameter": "string",
      "receiveItemParameterValues": "string",
      "receiveParameter": "string",
      "receiveParameterValues": "string",
      "receiveItemFromRefDoc": "string",
      "receiveItemFromRefDocLineNumber": "string",
      "receiveLocked": "boolean"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Resource

Resource/Part centric API

Assign Sensors

POST /sensors/assign

Used to assign sensors to resources.

Request Content-Types: application/json
Request Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "SensorTypeId": "integer",
      "Quantity": "number",
      "ResourceName": "string",
      "ResourceId": "string",
      "Timestamp": "number"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Unassign Sensors

POST /sensors/unassign

Used to Unassign sensors from resources. Specifiy a ResourceName or ResourceId to explicitly unassign from a specific resource. If both ResourceName and ResourceId is not defined then it will unassign the SensorKey from all resources in the ProjectId.

Request Content-Types: application/json
Request Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "SensorTypeId": "integer",
      "ResourceName": "string",
      "ResourceId": "integer",
      "Timestamp": "number"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Update Location (Geostamp)

POST /sensors/update-location

Update the location of a resource (geo-stamp or named location).

Request Content-Types: application/json
Request Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "ResourceName": "string",
      "ResourceId": "string",
      "Latitude": "number",
      "Longitude": "number",
      "LocationName": "string",
      "Accuracy": "number",
      "Timestamp": "number"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Get Resource by Sensor

POST /resource/resourceBySensorKey

Get Resource details by Sensor identifer.

Request Content-Types: application/json
Request Example
{
  "SensorKey": "string"
}

200 response

Response Content-Types: application/json
Response Example (200 OK)
{
  "ResourceGuid": "Guid",
  "Name": "string",
  "Description": "string",
  "UnitOfMeasure": "string",
  "ResourceTracking": [
    {
      "TrackedQuantity": "float",
      "TrackedInstanceIdentifier": "Guid",
      "Sensors": [
        {
          "SensorKey": "string",
          "Status": "integer"
        }
      ],
      "Location": {
        "GeographicPosition": {
          "Latitude": "float",
          "Longitude": "float"
        },
        "Confidence": "float",
        "DateSeen": "date",
        "Name": "string"
      }
    }
  ],
  "Projects": [
    {
      "ProjectId": "integer",
      "Name": "string"
    }
  ],
  "Commodity": "string",
  "Metadata": {
    "CreatedAtUtc": "date",
    "UpdatedAtUtc": "date",
    "UpdatedBySystem": "string",
    "UpdatedByUser": "string"
  }
}

Get Resource by ID

POST /resource/resourceDetail

Get Resource details by SiteSense resource identifier.

Request Content-Types: application/json
Request Example
{
  "ResourceId": "string"
}

200 response

Response Content-Types: application/json
Response Example (200 OK)
{
  "ResourceGuid": "Guid",
  "Name": "string",
  "Description": "string",
  "UnitOfMeasure": "string",
  "ResourceTracking": [
    {
      "TrackedQuantity": "float",
      "TrackedInstanceIdentifier": "Guid",
      "Sensors": [
        {
          "SensorKey": "string",
          "Status": "integer"
        }
      ],
      "Location": {
        "GeographicPosition": {
          "Latitude": "float",
          "Longitude": "float"
        },
        "Confidence": "float",
        "DateSeen": "date",
        "Name": "string"
      }
    }
  ],
  "Projects": [
    {
      "ProjectId": "integer",
      "Name": "string"
    }
  ],
  "Commodity": "string",
  "Metadata": {
    "CreatedAtUtc": "date",
    "UpdatedAtUtc": "date",
    "UpdatedBySystem": "string",
    "UpdatedByUser": "string"
  }
}

Search

POST /resource/search

Search for SiteSense Resources.

Request Content-Types: application/json
Request Example
{
  "ProjectId": "integer",
  "SearchTerm": "string",
  "StartRecord": "integer",
  "EndRecord": "integer",
  "ResourceSearchOptions": "object"
}

200 response

Response Content-Types: application/json
Response Example (200 OK)
{
  "TotalCount": "number",
  "SiteSenseResource": [
    {
      "ResourceGuid": "Guid",
      "Name": "string",
      "Description": "string",
      "UnitOfMeasure": "string",
      "ResourceTracking": [
        {
          "TrackedQuantity": "float",
          "TrackedInstanceIdentifier": "Guid",
          "Sensors": [
            {
              "SensorKey": "string",
              "Status": "integer"
            }
          ],
          "Location": {
            "GeographicPosition": {
              "Latitude": "float",
              "Longitude": "float"
            },
            "Confidence": "float",
            "DateSeen": "date",
            "Name": "string"
          }
        }
      ],
      "Projects": [
        {
          "ProjectId": "integer",
          "Name": "string"
        }
      ],
      "Commodity": "string",
      "Metadata": {
        "CreatedAtUtc": "date",
        "UpdatedAtUtc": "date",
        "UpdatedBySystem": "string",
        "UpdatedByUser": "string"
      }
    }
  ]
}

Upload Attachment

POST /resource/importattachment
projectId

ProjectID of the resource

type
string
in
header
resourceName

Name of the resource

type
string
in
header
attachmentName

Name of the attachment

type
string
in
header
Content-Type

Binary image

type
string
in
header
extension

.jpg or .png

type
string
in
header
attachmentType

Attachment Type, look at schema definition for more details

type
object
in
header
resourceType

Resource Type, look at schema definition for more details

type
string
in
header
200 OK

200 response

Response Content-Types: application/json

Set Attachment URL

POST /resource/setAttachment

Used to set attachments for resources.

Request Content-Types: application/json
Request Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "ResourceName": "string",
      "ResourceId": "number",
      "FileName": "string",
      "Type": "string",
      "URL": "string",
      "Description": "string"
    }
  ]
}
200 OK

200 response

Response Content-Types: application/json

Admin

Admin Centric API

Get Sites

GET Admin/sites
projectId

project ID to filter by

type
string
in
query
200 OK

Successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "Sites": {
      "SiteID": "integer",
      "LocationName": "String",
      "Location": {
        "SiteLocation": {
          "srid": "integer",
          "version": "integer",
          "points": {
            "Longitude": "float",
            "Latitude": "float"
          }
        }
      }
    }
  }
]

Schema Definitions

ResourceObject: object

resources: Resources
Example
{
  "resources": [
    {
      "name": "string",
      "description": "string",
      "uom": "string",
      "commodity": "boolean",
      "resourceTypeID": "integer",
      "schemaID": "integer",
      "propertyNames": "string",
      "propertyValues": "string",
      "projectID": "integer"
    }
  ]
}

Resources: object

name: string

Name of resource

description: string

Short description of resource

uom: string

Unit of measure of resource

commodity: boolean

Flag if resource is commodity or unique

resourceTypeID: integer

Resource type

schemaID: integer

Workflow definition

propertyNames: string

Resource parameter names.Separated by '|'

propertyValues: string

Resource parameter values.Separated by '|'

projectID: integer

ID associated with project

Example
{
  "name": "string",
  "description": "string",
  "uom": "string",
  "commodity": "boolean",
  "resourceTypeID": "integer",
  "schemaID": "integer",
  "propertyNames": "string",
  "propertyValues": "string",
  "projectID": "integer"
}

PurchaseOrder: object

referenceDocumentImports: PurchaseOrderLineItem
Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "poName": "string",
      "poDescription": "string",
      "poItemLineNumber": "string",
      "poItemSubLineNumber": "integer",
      "poItemName": "string",
      "poItemDescription": "string",
      "poItemQuantity": "string",
      "poItemUOM": "string",
      "poItemResourceTypeID": "integer",
      "poItemExecutionDate": "string",
      "poItemParameter": "string",
      "poItemParameterValues": "string",
      "poParameter": "string",
      "poParameterValues": "string",
      "poLocked": "boolean"
    }
  ]
}

PurchaseOrderLineItem: object

projectID: integer

ID associated with project

poName: string

PO name

poDescription: string

PO description

poItemLineNumber: string

PO line item number

poItemSubLineNumber: integer

PO sub line item number

poItemName: string

Name of resource on line item

poItemDescription: string

Short description of resource on line item

poItemQuantity: string

Quantity for line item

poItemUOM: string

Unit of measure for line item

poItemResourceTypeID: integer

Resource type

poItemExecutionDate: string

Expected PO delivery date

poItemParameter: string

Line item parameter names. Separated by '|'

poItemParameterValues: string

Line item parameter values. Separated by '|'

poParameter: string

Parameter names. Separated by '|'

poParameterValues: string

Parameter values. Separated by '|'

poLocked: boolean

Document state. Defaults to true. When locked users are unable to edit document.

Example
{
  "projectID": "integer",
  "poName": "string",
  "poDescription": "string",
  "poItemLineNumber": "string",
  "poItemSubLineNumber": "integer",
  "poItemName": "string",
  "poItemDescription": "string",
  "poItemQuantity": "string",
  "poItemUOM": "string",
  "poItemResourceTypeID": "integer",
  "poItemExecutionDate": "string",
  "poItemParameter": "string",
  "poItemParameterValues": "string",
  "poParameter": "string",
  "poParameterValues": "string",
  "poLocked": "boolean"
}

Shipment: object

referenceDocumentImports: ShipmentLineItem
Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "shipmentName": "string",
      "shipmentDescription": "string",
      "shipmentItemLineNumber": "string",
      "shipmentItemSubLineNumber": "integer",
      "shipmentItemName": "string",
      "shipmentItemQuantity": "string",
      "shipmentItemUOM": "string",
      "shipmentItemResourceTypeID": "integer",
      "shipmentItemExecutionDate": "string",
      "shipmentItemParameter": "string",
      "shipmentItemParameterValues": "string",
      "shipmentParameter": "string",
      "shipmentParameterValues": "string",
      "shipmentItemFromRefDoc": "string",
      "shipmentItemFromRefDocLineNumber": "string",
      "shipmentLocked": "boolean"
    }
  ]
}

ShipmentLineItem: object

projectID: integer

ID associated with project

shipmentName: string

Shipment name

shipmentDescription: string

Shipment description

shipmentItemLineNumber: string

Shipment line item number

shipmentItemSubLineNumber: integer

Shipment sub line item number

shipmentItemName: string

Name of resource on line item

shipmentItemQuantity: string

Quantity for line item

shipmentItemUOM: string

Unit of measure for line item

shipmentItemResourceTypeID: integer

Resource Type

shipmentItemExecutionDate: string

Expected delivery date

shipmentItemParameter: string

Line item parameter names. Seperated by '|'

shipmentItemParameterValues: string

Line item parameter values. Seperated by '|'

shipmentParameter: string

parameter names. Seperated by '|'

shipmentParameterValues: string

Parameter values. Seperated by '|'

shipmentItemFromRefDoc: string

Shipment relationship

shipmentItemFromRefDocLineNumber: string

Shipment line item relationship

shipmentLocked: boolean

Document state. Defaults to true. When locked users are unable to edit document.

Example
{
  "projectID": "integer",
  "shipmentName": "string",
  "shipmentDescription": "string",
  "shipmentItemLineNumber": "string",
  "shipmentItemSubLineNumber": "integer",
  "shipmentItemName": "string",
  "shipmentItemQuantity": "string",
  "shipmentItemUOM": "string",
  "shipmentItemResourceTypeID": "integer",
  "shipmentItemExecutionDate": "string",
  "shipmentItemParameter": "string",
  "shipmentItemParameterValues": "string",
  "shipmentParameter": "string",
  "shipmentParameterValues": "string",
  "shipmentItemFromRefDoc": "string",
  "shipmentItemFromRefDocLineNumber": "string",
  "shipmentLocked": "boolean"
}

Receipt: object

referenceDocumentImports: ReceiptLineItem
Example
{
  "referenceDocumentImports": [
    {
      "projectID": "integer",
      "receiveName": "string",
      "receiveDescription": "string",
      "receiveItemLineNumber": "string",
      "receiveItemSubLineNumber": "string",
      "receiveItemName": "string",
      "receiveItemQuantity": "string",
      "receiveItemUOM": "string",
      "receiveItemResourceTypeID": "integer",
      "receiveItemExecutionDate": "string",
      "receiveItemParameter": "string",
      "receiveItemParameterValues": "string",
      "receiveParameter": "string",
      "receiveParameterValues": "string",
      "receiveItemFromRefDoc": "string",
      "receiveItemFromRefDocLineNumber": "string",
      "receiveLocked": "boolean"
    }
  ]
}

ReceiptLineItem: object

projectID: integer

ID associated with project

receiveName: string

Receipt name

receiveDescription: string

Receipt description

receiveItemLineNumber: string

Receipt line item number

receiveItemSubLineNumber: string

Receipt sub line item number

receiveItemName: string

Name of resource on line item

receiveItemQuantity: string

Quantity for line item

receiveItemUOM: string

Unit of measure for line item

receiveItemResourceTypeID: integer

Resource Type

receiveItemExecutionDate: string

Expected delivery date

receiveItemParameter: string

Line item parameter names. Seperated by '|'

receiveItemParameterValues: string

Line item parameter values. Seperated by '|'

receiveParameter: string

Parameter names. Seperated by '|'

receiveParameterValues: string

Parameter values. Seperated by '|'

receiveItemFromRefDoc: string

Receipt relationship

receiveItemFromRefDocLineNumber: string

Receipt line item relationship

receiveLocked: boolean

Document state. Defaults to true. When locked users are unable to edit document.

Example
{
  "projectID": "integer",
  "receiveName": "string",
  "receiveDescription": "string",
  "receiveItemLineNumber": "string",
  "receiveItemSubLineNumber": "string",
  "receiveItemName": "string",
  "receiveItemQuantity": "string",
  "receiveItemUOM": "string",
  "receiveItemResourceTypeID": "integer",
  "receiveItemExecutionDate": "string",
  "receiveItemParameter": "string",
  "receiveItemParameterValues": "string",
  "receiveParameter": "string",
  "receiveParameterValues": "string",
  "receiveItemFromRefDoc": "string",
  "receiveItemFromRefDocLineNumber": "string",
  "receiveLocked": "boolean"
}

SiteSenseResource: object

ResourceGuid: Guid

Resource GUID in C# format

Name: string

Resource name

Description: string

Resource description

UnitOfMeasure: string

Unit of measure of the resource

ResourceTracking: ResourceTracking

Resource tracking array

Projects: Projects

Resource project array

Commodity: string
Metadata: object
Example
{
  "ResourceGuid": "Guid",
  "Name": "string",
  "Description": "string",
  "UnitOfMeasure": "string",
  "ResourceTracking": [
    {
      "TrackedQuantity": "float",
      "TrackedInstanceIdentifier": "Guid",
      "Sensors": [
        {
          "SensorKey": "string",
          "Status": "integer"
        }
      ],
      "Location": {
        "GeographicPosition": {
          "Latitude": "float",
          "Longitude": "float"
        },
        "Confidence": "float",
        "DateSeen": "date",
        "Name": "string"
      }
    }
  ],
  "Projects": [
    {
      "ProjectId": "integer",
      "Name": "string"
    }
  ],
  "Commodity": "string",
  "Metadata": {
    "CreatedAtUtc": "date",
    "UpdatedAtUtc": "date",
    "UpdatedBySystem": "string",
    "UpdatedByUser": "string"
  }
}

ResourceTracking: object

TrackedQuantity: float

Quantity being tracked by sensor key

TrackedInstanceIdentifier: Guid

ResourceTracking GUID

Sensors: Sensors

Array containing sensor objects

Location: object
Example
{
  "TrackedQuantity": "float",
  "TrackedInstanceIdentifier": "Guid",
  "Sensors": [
    {
      "SensorKey": "string",
      "Status": "integer"
    }
  ],
  "Location": {
    "GeographicPosition": {
      "Latitude": "float",
      "Longitude": "float"
    },
    "Confidence": "float",
    "DateSeen": "date",
    "Name": "string"
  }
}

Sensors: object

SensorKey: string

Sensor key associated to the resource

Status: integer

1 for normal, 2 for low battery

Example
{
  "SensorKey": "string",
  "Status": "integer"
}

Projects: object

ProjectId: integer

Project ID number

Name: string

Name of the project

Example
{
  "ProjectId": "integer",
  "Name": "string"
}

SensorAssign: object

UpdateSystemName: string

System or Users who updated the sensor assignments.

ProjectId: integer

SiteSense Project to apply the changes.

task: SensorAssignObject
Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "SensorTypeId": "integer",
      "Quantity": "number",
      "ResourceName": "string",
      "ResourceId": "string",
      "Timestamp": "number"
    }
  ]
}

SensorAssignObject: object

SensorKey: string

Barcode or sensorID.

SensorTypeId: integer

Optional parameter to specify the type of sensor (Barcode, RFID, ...). Default is Barcode (10).

Quantity: number

Optional parameter to specify the quantity associated to a sensor on bundle or commodity.

ResourceName: string

Name of the resource.

ResourceId: string

Unique Resource Identifier.

Timestamp: number

Timestamp when the event occurs (UTC).

Example
{
  "SensorKey": "string",
  "SensorTypeId": "integer",
  "Quantity": "number",
  "ResourceName": "string",
  "ResourceId": "string",
  "Timestamp": "number"
}

SensorUnassign: object

UpdateSystemName: string

System or Users who updated the sensor assignments.

ProjectId: integer

SiteSense Project to apply the changes.

task: SensorUnassignObject
Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "SensorTypeId": "integer",
      "ResourceName": "string",
      "ResourceId": "integer",
      "Timestamp": "number"
    }
  ]
}

SensorUnassignObject: object

SensorKey: string

Barcode or sensor number.

SensorTypeId: integer

Optional parameter used to distinguish different types of sensors that use the same id.

ResourceName: string

Name of the resource. If supplied will only unassign sensor from this resource.

ResourceId: integer

Unique resource idenfitier. If supplied will only unassign sensor from this resource.

Timestamp: number

UTC timestamp

Example
{
  "SensorKey": "string",
  "SensorTypeId": "integer",
  "ResourceName": "string",
  "ResourceId": "integer",
  "Timestamp": "number"
}

SetAttachment: object

UpdateSystemName: string

System or Users who updated the sensor assignments.

ProjectId: integer

SiteSense Project to apply the changes.

task: SetAttachmentObject
Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "ResourceName": "string",
      "ResourceId": "number",
      "FileName": "string",
      "Type": "string",
      "URL": "string",
      "Description": "string"
    }
  ]
}

SetAttachmentObject: object

ResourceName: string

Name of the resource.

ResourceId: number

SiteSense Resource ID.

FileName: string

Original filename.

Type: string

Type of attachment.

URL: string

URL Path to Attachment.

Description: string

Description of Attachment.

Example
{
  "ResourceName": "string",
  "ResourceId": "number",
  "FileName": "string",
  "Type": "string",
  "URL": "string",
  "Description": "string"
}

SensorLocation: object

UpdateSystemName: string

System or Users who updated the sensor assignments.

ProjectId: integer

SiteSense Project to apply the changes.

task: LocationObject
Example
{
  "UpdateSystemName": "string",
  "ProjectId": "integer",
  "task": [
    {
      "SensorKey": "string",
      "ResourceName": "string",
      "ResourceId": "string",
      "Latitude": "number",
      "Longitude": "number",
      "LocationName": "string",
      "Accuracy": "number",
      "Timestamp": "number"
    }
  ]
}

LocationObject: object

SensorKey: string

Barcode or sensorID.

ResourceName: string

Name of the resource.

ResourceId: string

Unique Resource Identifier.

Latitude: number

Latitude geo-coordinate.

Longitude: number

Longitude geo-coordinate.

LocationName: string

Name of the location. SiteSense location hierarchy is separated by '>' character. (eg. Site > Area > Warehouse > Bin)

Accuracy: number

Accuracy/Confidence of the supplied location coordinates (meters).

Timestamp: number

UTC Timestamp

Example
{
  "SensorKey": "string",
  "ResourceName": "string",
  "ResourceId": "string",
  "Latitude": "number",
  "Longitude": "number",
  "LocationName": "string",
  "Accuracy": "number",
  "Timestamp": "number"
}

ResourceBySensorKey: object

SensorKey: string

Sensor identifer that is assigned to the resource.

Example
{
  "SensorKey": "string"
}

ResourceByID: object

ResourceId: string

SiteSense ID of the resource. This could be a Guid or an Integer.

Example
{
  "ResourceId": "string"
}

ResourceSearch: object

ProjectId: integer

SiteSense ID of the resource. This could be a Guid or an Integer.

SearchTerm: string

Keyword to search. The keyword searches fields: name, description, sensor key and keywords.

StartRecord: integer

Paginate results using StartRecord/EndRecord. Default: 1.

EndRecord: integer

Paginate results using StartRecord/EndRecord. Default: 10.

ResourceSearchOptions: object

Additional search options.

Example
{
  "ProjectId": "integer",
  "SearchTerm": "string",
  "StartRecord": "integer",
  "EndRecord": "integer",
  "ResourceSearchOptions": "object"
}

ResourceSearchOptions: object

ResourceClass: integer

SiteSense resource class (1 - Material, 2 - Equipment, 4 - Workforce, 6 - Lists/Packages, 7 - Reference Document).

ResourceType: integer

SiteSense resource type.

SensorStatus: integer

Search for resources with sensor status.

AttachmentStatus: integer

Search for resources with attachment types.

Timestamp: number

UTC timestamp

Example
{
  "ResourceClass": "integer",
  "ResourceType": "integer",
  "SensorStatus": "integer",
  "AttachmentStatus": "integer",
  "Timestamp": "number"
}

ResourceSearchResult: object

TotalCount: number

Total number of resources that match the search criteria.

SiteSenseResource: SiteSenseResource

Array of resource details.

Example
{
  "TotalCount": "number",
  "SiteSenseResource": [
    {
      "ResourceGuid": "Guid",
      "Name": "string",
      "Description": "string",
      "UnitOfMeasure": "string",
      "ResourceTracking": [
        {
          "TrackedQuantity": "float",
          "TrackedInstanceIdentifier": "Guid",
          "Sensors": [
            {
              "SensorKey": "string",
              "Status": "integer"
            }
          ],
          "Location": {
            "GeographicPosition": {
              "Latitude": "float",
              "Longitude": "float"
            },
            "Confidence": "float",
            "DateSeen": "date",
            "Name": "string"
          }
        }
      ],
      "Projects": [
        {
          "ProjectId": "integer",
          "Name": "string"
        }
      ],
      "Commodity": "string",
      "Metadata": {
        "CreatedAtUtc": "date",
        "UpdatedAtUtc": "date",
        "UpdatedBySystem": "string",
        "UpdatedByUser": "string"
      }
    }
  ]
}

Response: object

date: string

UNIX timestamp

report: string

Errors if any

guid: string

Guid Of the transaction in C# format

Example
{
  "date": "string",
  "report": "string",
  "guid": "string"
}

AttachmentType: object

Photo: 2
Document: 3
Signature: 6
SignedDocument: 7
Example
{
  "Photo": "2",
  "Document": "3",
  "Signature": "6",
  "SignedDocument": "7"
}

AttachmentTypeEnum: string

string photo, document, signature

SensorStatusSearch: object

All: 0
Assigned: 1
NotAssigned: 2
LowBattery: 3
Example
{
  "All": "0",
  "Assigned": "1",
  "NotAssigned": "2",
  "LowBattery": "3"
}

AttachmentSearch: object

All: 0
NoAttachment: -1
NoPhoto: -2
NoDocuments: -3
HasAttachments: -4
HasPhotos: -5
Example
{
  "All": "0",
  "NoAttachment": "-1",
  "NoPhoto": "-2",
  "NoDocuments": "-3",
  "HasAttachments": "-4",
  "HasPhotos": "-5"
}

ResourceType: object

Piping: 4
Structural: 5
RawMaterial: 6
Electrical: 7
Mechanical: 8
Instrumentation: 9
Surplus: 10
Consumables: 11
Miscellaneous: 15
Cable_Reel: 16
Valve: 17
Pipe_Support: 18
Ductwork: 19
Uncategorized_Equipment: 200
Light_Stand_Generator: 201
Light_Stand: 202
Forklift: 203
Fire_Extinguisher: 204
Generator: 205
Skid: 206
Compressor: 207
Welder: 208
Light_Tower: 209
Trash_Pump: 210
Ground_Heater: 211
Equipment_Attachment: 212
Herman_Nelson_Heater: 213
Electronic: 214
Zoom_Boom: 215
Propane_Tank: 216
Fuel_Tank: 217
Skid_Steer: 218
Rock_Truck: 219
Excavator: 220
Grader: 221
Tractor_Trailer_Truck: 222
Flat_Deck_Truck: 223
Pick_Up_Truck: 224
Scaffolding: 225
Flat_Deck_Trailer: 226
Packer: 227
Front_End_Loader: 229
Frost_Fighter: 230
Scissor_Lift: 231
Aerial_Work_Platform: 232
Heater: 233
Water_Pump: 234
Electrical_Panel: 235
Utility_Vehicle: 236
Crane: 237
Pressure_Washer: 238
Radio: 239
SCBA: 240
Gas_Detection_Unit: 241
Impacter: 242
Trowel: 243
Electric_Heater: 244
Cement_Mixer: 245
Office_Trailer: 246
C_CAN: 247
PPE: 248
IT: 249
Office: 250
Signage: 251
Barriers: 252
Rigging: 253
Ladder: 254
Harness: 255
Mechanical_Equipment: 256
Small_Tool: 257
Hand_Tool: 254
Example
{
  "Piping": "4",
  "Structural": "5",
  "RawMaterial": "6",
  "Electrical": "7",
  "Mechanical": "8",
  "Instrumentation": "9",
  "Surplus": "10",
  "Consumables": "11",
  "Miscellaneous": "15",
  "Cable_Reel": "16",
  "Valve": "17",
  "Pipe_Support": "18",
  "Ductwork": "19",
  "Uncategorized_Equipment": "200",
  "Light_Stand_Generator": "201",
  "Light_Stand": "202",
  "Forklift": "203",
  "Fire_Extinguisher": "204",
  "Generator": "205",
  "Skid": "206",
  "Compressor": "207",
  "Welder": "208",
  "Light_Tower": "209",
  "Trash_Pump": "210",
  "Ground_Heater": "211",
  "Equipment_Attachment": "212",
  "Herman_Nelson_Heater": "213",
  "Electronic": "214",
  "Zoom_Boom": "215",
  "Propane_Tank": "216",
  "Fuel_Tank": "217",
  "Skid_Steer": "218",
  "Rock_Truck": "219",
  "Excavator": "220",
  "Grader": "221",
  "Tractor_Trailer_Truck": "222",
  "Flat_Deck_Truck": "223",
  "Pick_Up_Truck": "224",
  "Scaffolding": "225",
  "Flat_Deck_Trailer": "226",
  "Packer": "227",
  "Front_End_Loader": "229",
  "Frost_Fighter": "230",
  "Scissor_Lift": "231",
  "Aerial_Work_Platform": "232",
  "Heater": "233",
  "Water_Pump": "234",
  "Electrical_Panel": "235",
  "Utility_Vehicle": "236",
  "Crane": "237",
  "Pressure_Washer": "238",
  "Radio": "239",
  "SCBA": "240",
  "Gas_Detection_Unit": "241",
  "Impacter": "242",
  "Trowel": "243",
  "Electric_Heater": "244",
  "Cement_Mixer": "245",
  "Office_Trailer": "246",
  "C_CAN": "247",
  "PPE": "248",
  "IT": "249",
  "Office": "250",
  "Signage": "251",
  "Barriers": "252",
  "Rigging": "253",
  "Ladder": "254",
  "Harness": "255",
  "Mechanical_Equipment": "256",
  "Small_Tool": "257",
  "Hand_Tool": "254"
}