POST api/Devices

Insert Devices

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DeviceId	integer	None.
DeviceName	string	Required
DeviceSKU	string	None.
Protocol	string	None.
ClientID	string	None.
Topic	string	None.
Widgets	integer	None.
DeviceType	string	None.
DeviceStatus	integer	None.
AddedFrom	integer	None.
IsActive	integer	None.
AddedBy	integer	None.
iOTDeviceGUID	string	None.
DeviceDescription	string	None.
iOTStatus	string	None.
iOTcompanyID	string	None.
iOTdeviceSlug	string	None.
ParamsList	Collection of DeviceParamsRequestModel	None.
DeviceOrigin	string	None.
CameraSerial	string	None.
HarshAccelerationSettingType	string	None.
Make	string	None.
Model	string	None.
Notes	string	None.
Serial	string	None.
Vin	string	None.
VehicleRegulationMode	string	None.
Esn	string	None.
Year	integer	None.
SamsaraCreatedAtTime	string	None.
SamsaraUpdatedAtTime	string	None.
GatewaySerial	string	None.
GatewayModel	string	None.
SamsaraTagId	integer	None.
SamsaraTagName	string	None.
ReportInterval	integer	None.
ActiveStateInterval	integer	None.
InactivityAlert	integer	None.
MeasurementsPerTransmission	integer	None.
MinimumThreshold	integer	None.
MaximumThreshold	integer	None.
Hysteresis	integer	None.
Tag	string	None.
ApplicationID	integer	None.
CSNetID	integer	None.
LastCommunicationDate	date	None.
NextCommunicationDate	date	None.
LastDataMessageMessageGUID	string	None.
PowerSourceID	integer	None.
Status	integer	None.
CanUpdate	boolean	None.
CurrentReading	string	None.
BatteryLevel	integer	None.
SignalStrength	integer	None.
AlertsActive	boolean	None.
CheckDigit	string	None.
AccountID	integer	None.
MonnitApplicationID	integer	None.
entityType	string	None.
entityTypeID	string	None.
ownerEntityType	string	None.
ownerId	string	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "deviceId": 1,
  "deviceName": "sample string 1",
  "deviceSKU": "sample string 2",
  "protocol": "sample string 3",
  "clientID": "sample string 4",
  "topic": "sample string 5",
  "widgets": 1,
  "deviceType": "sample string 6",
  "deviceStatus": 1,
  "addedFrom": 1,
  "isActive": 1,
  "addedBy": 1,
  "iOTDeviceGUID": "sample string 7",
  "deviceDescription": "sample string 8",
  "iOTStatus": "sample string 9",
  "iOTcompanyID": "sample string 10",
  "iOTdeviceSlug": "sample string 11",
  "paramsList": [
    {
      "paramName": "sample string 1",
      "iOTDeviceParamGUID": "sample string 2",
      "description": "sample string 3",
      "deviceOrigin": "sample string 4"
    },
    {
      "paramName": "sample string 1",
      "iOTDeviceParamGUID": "sample string 2",
      "description": "sample string 3",
      "deviceOrigin": "sample string 4"
    }
  ],
  "deviceOrigin": "sample string 12",
  "cameraSerial": "sample string 13",
  "harshAccelerationSettingType": "sample string 14",
  "make": "sample string 15",
  "model": "sample string 16",
  "notes": "sample string 17",
  "serial": "sample string 18",
  "vin": "sample string 19",
  "vehicleRegulationMode": "sample string 20",
  "esn": "sample string 21",
  "year": 1,
  "samsaraCreatedAtTime": "sample string 22",
  "samsaraUpdatedAtTime": "sample string 23",
  "gatewaySerial": "sample string 24",
  "gatewayModel": "sample string 25",
  "samsaraTagId": 1,
  "samsaraTagName": "sample string 26",
  "reportInterval": 1,
  "activeStateInterval": 1,
  "inactivityAlert": 1,
  "measurementsPerTransmission": 1,
  "minimumThreshold": 1,
  "maximumThreshold": 1,
  "hysteresis": 1,
  "tag": "sample string 27",
  "applicationID": 1,
  "csNetID": 1,
  "lastCommunicationDate": "2025-07-17T04:27:55.4999965+00:00",
  "nextCommunicationDate": "2025-07-17T04:27:55.4999965+00:00",
  "lastDataMessageMessageGUID": "sample string 28",
  "powerSourceID": 1,
  "status": 1,
  "canUpdate": true,
  "currentReading": "sample string 29",
  "batteryLevel": 1,
  "signalStrength": 1,
  "alertsActive": true,
  "checkDigit": "sample string 30",
  "accountID": 1,
  "monnitApplicationID": 1,
  "entityType": "sample string 31",
  "entityTypeID": "sample string 32",
  "ownerEntityType": "sample string 33",
  "ownerId": "sample string 34"
}

application/xml, text/xml

Sample:

<DevicesInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <AccountID>1</AccountID>
  <ActiveStateInterval>1</ActiveStateInterval>
  <AddedBy>1</AddedBy>
  <AddedFrom>1</AddedFrom>
  <AlertsActive>true</AlertsActive>
  <ApplicationID>1</ApplicationID>
  <BatteryLevel>1</BatteryLevel>
  <CSNetID>1</CSNetID>
  <CameraSerial>sample string 13</CameraSerial>
  <CanUpdate>true</CanUpdate>
  <CheckDigit>sample string 30</CheckDigit>
  <ClientID>sample string 4</ClientID>
  <CurrentReading>sample string 29</CurrentReading>
  <DeviceDescription>sample string 8</DeviceDescription>
  <DeviceId>1</DeviceId>
  <DeviceName>sample string 1</DeviceName>
  <DeviceOrigin>sample string 12</DeviceOrigin>
  <DeviceSKU>sample string 2</DeviceSKU>
  <DeviceStatus>1</DeviceStatus>
  <DeviceType>sample string 6</DeviceType>
  <Esn>sample string 21</Esn>
  <GatewayModel>sample string 25</GatewayModel>
  <GatewaySerial>sample string 24</GatewaySerial>
  <HarshAccelerationSettingType>sample string 14</HarshAccelerationSettingType>
  <Hysteresis>1</Hysteresis>
  <InactivityAlert>1</InactivityAlert>
  <IsActive>1</IsActive>
  <LastCommunicationDate>2025-07-17T04:27:55.4999965+00:00</LastCommunicationDate>
  <LastDataMessageMessageGUID>sample string 28</LastDataMessageMessageGUID>
  <Make>sample string 15</Make>
  <MaximumThreshold>1</MaximumThreshold>
  <MeasurementsPerTransmission>1</MeasurementsPerTransmission>
  <MinimumThreshold>1</MinimumThreshold>
  <Model>sample string 16</Model>
  <MonnitApplicationID>1</MonnitApplicationID>
  <NextCommunicationDate>2025-07-17T04:27:55.4999965+00:00</NextCommunicationDate>
  <Notes>sample string 17</Notes>
  <ParamsList>
    <DeviceParamsRequestModel>
      <Description>sample string 3</Description>
      <DeviceOrigin>sample string 4</DeviceOrigin>
      <ParamName>sample string 1</ParamName>
      <iOTDeviceParamGUID>sample string 2</iOTDeviceParamGUID>
    </DeviceParamsRequestModel>
    <DeviceParamsRequestModel>
      <Description>sample string 3</Description>
      <DeviceOrigin>sample string 4</DeviceOrigin>
      <ParamName>sample string 1</ParamName>
      <iOTDeviceParamGUID>sample string 2</iOTDeviceParamGUID>
    </DeviceParamsRequestModel>
  </ParamsList>
  <PowerSourceID>1</PowerSourceID>
  <Protocol>sample string 3</Protocol>
  <ReportInterval>1</ReportInterval>
  <SamsaraCreatedAtTime>sample string 22</SamsaraCreatedAtTime>
  <SamsaraTagId>1</SamsaraTagId>
  <SamsaraTagName>sample string 26</SamsaraTagName>
  <SamsaraUpdatedAtTime>sample string 23</SamsaraUpdatedAtTime>
  <Serial>sample string 18</Serial>
  <SignalStrength>1</SignalStrength>
  <Status>1</Status>
  <Tag>sample string 27</Tag>
  <Topic>sample string 5</Topic>
  <VehicleRegulationMode>sample string 20</VehicleRegulationMode>
  <Vin>sample string 19</Vin>
  <Widgets>1</Widgets>
  <Year>1</Year>
  <entityType>sample string 31</entityType>
  <entityTypeID>sample string 32</entityTypeID>
  <iOTDeviceGUID>sample string 7</iOTDeviceGUID>
  <iOTStatus>sample string 9</iOTStatus>
  <iOTcompanyID>sample string 10</iOTcompanyID>
  <iOTdeviceSlug>sample string 11</iOTdeviceSlug>
  <ownerEntityType>sample string 33</ownerEntityType>
  <ownerId>sample string 34</ownerId>
</DevicesInsertUpdateRequestModel>

multipart/form-data

Sample:

<DevicesInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><AccountID>1</AccountID><ActiveStateInterval>1</ActiveStateInterval><AddedBy>1</AddedBy><AddedFrom>1</AddedFrom><AlertsActive>true</AlertsActive><ApplicationID>1</ApplicationID><BatteryLevel>1</BatteryLevel><CSNetID>1</CSNetID><CameraSerial>sample string 13</CameraSerial><CanUpdate>true</CanUpdate><CheckDigit>sample string 30</CheckDigit><ClientID>sample string 4</ClientID><CurrentReading>sample string 29</CurrentReading><DeviceDescription>sample string 8</DeviceDescription><DeviceId>1</DeviceId><DeviceName>sample string 1</DeviceName><DeviceOrigin>sample string 12</DeviceOrigin><DeviceSKU>sample string 2</DeviceSKU><DeviceStatus>1</DeviceStatus><DeviceType>sample string 6</DeviceType><Esn>sample string 21</Esn><GatewayModel>sample string 25</GatewayModel><GatewaySerial>sample string 24</GatewaySerial><HarshAccelerationSettingType>sample string 14</HarshAccelerationSettingType><Hysteresis>1</Hysteresis><InactivityAlert>1</InactivityAlert><IsActive>1</IsActive><LastCommunicationDate>2025-07-17T04:27:55.4999965+00:00</LastCommunicationDate><LastDataMessageMessageGUID>sample string 28</LastDataMessageMessageGUID><Make>sample string 15</Make><MaximumThreshold>1</MaximumThreshold><MeasurementsPerTransmission>1</MeasurementsPerTransmission><MinimumThreshold>1</MinimumThreshold><Model>sample string 16</Model><MonnitApplicationID>1</MonnitApplicationID><NextCommunicationDate>2025-07-17T04:27:55.4999965+00:00</NextCommunicationDate><Notes>sample string 17</Notes><ParamsList><DeviceParamsRequestModel><Description>sample string 3</Description><DeviceOrigin>sample string 4</DeviceOrigin><ParamName>sample string 1</ParamName><iOTDeviceParamGUID>sample string 2</iOTDeviceParamGUID></DeviceParamsRequestModel><DeviceParamsRequestModel><Description>sample string 3</Description><DeviceOrigin>sample string 4</DeviceOrigin><ParamName>sample string 1</ParamName><iOTDeviceParamGUID>sample string 2</iOTDeviceParamGUID></DeviceParamsRequestModel></ParamsList><PowerSourceID>1</PowerSourceID><Protocol>sample string 3</Protocol><ReportInterval>1</ReportInterval><SamsaraCreatedAtTime>sample string 22</SamsaraCreatedAtTime><SamsaraTagId>1</SamsaraTagId><SamsaraTagName>sample string 26</SamsaraTagName><SamsaraUpdatedAtTime>sample string 23</SamsaraUpdatedAtTime><Serial>sample string 18</Serial><SignalStrength>1</SignalStrength><Status>1</Status><Tag>sample string 27</Tag><Topic>sample string 5</Topic><VehicleRegulationMode>sample string 20</VehicleRegulationMode><Vin>sample string 19</Vin><Widgets>1</Widgets><Year>1</Year><entityType>sample string 31</entityType><entityTypeID>sample string 32</entityTypeID><iOTDeviceGUID>sample string 7</iOTDeviceGUID><iOTStatus>sample string 9</iOTStatus><iOTcompanyID>sample string 10</iOTcompanyID><iOTdeviceSlug>sample string 11</iOTdeviceSlug><ownerEntityType>sample string 33</ownerEntityType><ownerId>sample string 34</ownerId></DevicesInsertUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>