POST api/v1/user/InsertUserMobileDeviceToken

Inserts or updates the user's mobile device token for push notifications. Equivalent SOAP API: InsertUserMobileDeviceToken

Request Information

URI Parameters

None.

Body Parameters

An object containing user and device token information.

UserMobileDeviceTokenInfo

Name	Type	Additional information
User_xref_MobileDeviceID	integer	None.
UserID	integer	None.
ClientSoftwareTypeID	integer	None.
MobileDeviceID	string	None.
ActiveState	boolean	None.
AccessToken	string	None.

Request Formats

application/json, text/json

Sample:

{
  "User_xref_MobileDeviceID": 1,
  "UserID": 2,
  "ClientSoftwareTypeID": 3,
  "MobileDeviceID": "sample string 4",
  "ActiveState": true,
  "AccessToken": "sample string 6"
}

application/xml, text/xml

Sample:

<UserMobileDeviceTokenInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
  <AccessToken>sample string 6</AccessToken>
  <ActiveState>true</ActiveState>
  <ClientSoftwareTypeID>3</ClientSoftwareTypeID>
  <MobileDeviceID>sample string 4</MobileDeviceID>
  <UserID>2</UserID>
  <User_xref_MobileDeviceID>1</User_xref_MobileDeviceID>
</UserMobileDeviceTokenInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An instance of containing the operation result and the generated access token.

InsertMobileDeviceTokenResult

Name	Type	Additional information
AccessToken	string	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "AccessToken": "sample string 1",
  "ResultCode": 2,
  "ResultData": "sample string 3"
}

application/xml, text/xml

Sample:

<InsertMobileDeviceTokenResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <AccessToken>sample string 1</AccessToken>
</InsertMobileDeviceTokenResult>