POST api/hire/notificationsubscription

Attempt to subscribe a mobile device to a SNS application

Request Information

URI Parameters

None.

Body Parameters

A NotificationSubscriptionModel object

Name	Description	Type	Additional information
token	The token returned after login used for authentication	string	None.
userID	The userid returned after login used for authentication	unsigned integer	None.
subscriptionPlatform	The application subscription platform you want notifications to go through	ApplicationSubscriptionPlatform	None.
deviceToken	The device token provided from the mobile device	string	None.

Request Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "userID": 2,
  "subscriptionPlatform": 0,
  "deviceToken": "sample string 3"
}

application/xml, text/xml

Sample:

<NotificationSubscriptionModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <token>sample string 1</token>
  <userID>2</userID>
  <subscriptionPlatform>APNS_SANDBOX</subscriptionPlatform>
  <deviceToken>sample string 3</deviceToken>
</NotificationSubscriptionModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A HireResponseModel indicating if the device was associated successfully

HireResponseModel

Name	Description	Type	Additional information
request_status	Status indicating if a web service call was successful	boolean	None.
request_message	Any extra information indicating why a call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "request_status": true,
  "request_message": "sample string 2"
}

application/xml, text/xml

Sample:

<HireResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <request_status>true</request_status>
  <request_message>sample string 2</request_message>
</HireResponseModel>