POST api/v3/Devices/RegisterDevice

Register a device to recieve push notificaiton from the Resgrid system

Request Information

URI Parameters

None.

Body Parameters

Input to create the registration for

DeviceRegistrationInputV3
NameDescriptionTypeAdditional information
Plt

The platform this device registration is going against

integer

None.

Did

The DeviceId to register with Resgrid for Push Notifications

string

None.

Uri

The PushUri (if needed by the target platform) for the device

string

None.

Uid

The UnitId of the device being registered if it's from the Unit App

integer

None.

Request Formats

application/json

Sample:
{
  "Plt": 1,
  "Did": "sample string 2",
  "Uri": "sample string 3",
  "Uid": 4
}

application/xml, text/xml

Sample:
<DeviceRegistrationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Devices">
  <Did>sample string 2</Did>
  <Plt>1</Plt>
  <Uid>4</Uid>
  <Uri>sample string 3</Uri>
</DeviceRegistrationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result for the registration

DeviceRegistrationResultV3
NameDescriptionTypeAdditional information
Id

Id of the device registration created

integer

None.

Typ

Platform type of the registration

string

None.

Sfl

Was the operational successful

boolean

None.

Response Formats

application/json

Sample:
{
  "Id": 1,
  "Typ": "sample string 2",
  "Sfl": true
}

application/xml, text/xml

Sample:
<DeviceRegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Devices">
  <Id>1</Id>
  <Sfl>true</Sfl>
  <Typ>sample string 2</Typ>
</DeviceRegistrationResult>