PUT api/Common/RegisterDevice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
DeviceType	string	None.
DeviceTokenId	string	None.
CustomerId	integer	None.
AppName	string	None.
UniqueId	globally unique identifier	None.
ContactId	integer	None.
OSVersion	string	None.
ModelNumber	string	None.
AppVersion	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
BadgeCount	integer	None.
CreatedDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "DeviceType": "sample string 2",
  "DeviceTokenId": "sample string 3",
  "CustomerId": 4,
  "AppName": "sample string 5",
  "UniqueId": "600670dd-f16f-48ff-a37f-96ce3c15ea3f",
  "ContactId": 1,
  "OSVersion": "sample string 7",
  "ModelNumber": "sample string 8",
  "AppVersion": "sample string 9",
  "Latitude": 1.0,
  "Longitude": 1.0,
  "BadgeCount": 10,
  "CreatedDate": "2026-02-04T02:40:09.6444041+00:00"
}

application/xml, text/xml

Sample:

<DeviceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <AppName>sample string 5</AppName>
  <AppVersion>sample string 9</AppVersion>
  <BadgeCount>10</BadgeCount>
  <ContactId>1</ContactId>
  <CreatedDate>2026-02-04T02:40:09.6444041+00:00</CreatedDate>
  <CustomerId>4</CustomerId>
  <DeviceTokenId>sample string 3</DeviceTokenId>
  <DeviceType>sample string 2</DeviceType>
  <Id>1</Id>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <ModelNumber>sample string 8</ModelNumber>
  <OSVersion>sample string 7</OSVersion>
  <UniqueId>600670dd-f16f-48ff-a37f-96ce3c15ea3f</UniqueId>
</DeviceInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegisterDeviceResponse

Name	Type	Additional information
AuthKey	string	None.
UniqueId	string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "AuthKey": "sample string 1",
  "UniqueId": "sample string 2",
  "Success": true
}

application/xml, text/xml

Sample:

<RegisterDeviceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <AuthKey>sample string 1</AuthKey>
  <Success>true</Success>
  <UniqueId>sample string 2</UniqueId>
</RegisterDeviceResponse>