Documentation for GET api/Revolution/PushNotification/UserPreference?repDID={repDID}

GET api/Revolution/PushNotification/UserPreference?repDID={repDID}

Retrieves the current user's notification preferences. These preferences are associated to how a user receives alerts. This is typically used in associated with push notification settings as the user may wish to disable Email and/or SMS notifications if they enabled push notifications.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDID	The user DID for whomever you'd like preferences for	string	Required

Body Parameters

None.

Response Information

Resource Description

RevolutionUserNotificationPreference

Name	Description	Type	Additional information
IsEmailEnabled	Dictates whether or not the user wants to receive emails for alerts	boolean	None.
Email	The user's email to use for Alerts	string	None.
IsSMSEnabled	Dictates whether or not the user wants to receive SMS for alerts	boolean	None.
SMSPhoneNumber	The user's phone number to use for Alerts	string	None.
PhoneCarrierId	The Carrier (from ~/api/Revolution/PhoneCarrier) associated with the phone number	integer	None.

Response Formats

application/xml, text/xml

Sample:

<RevolutionUserNotificationPreference>
  <IsEmailEnabled>True</IsEmailEnabled>
  <Email>sample string 1</Email>
  <IsSMSEnabled>True</IsSMSEnabled>
  <SMSPhoneNumber>sample string 2</SMSPhoneNumber>
  <PhoneCarrierId>1</PhoneCarrierId>
</RevolutionUserNotificationPreference>

application/json, text/json

Sample:

{
  "IsEmailEnabled": true,
  "Email": "sample string 1",
  "IsSMSEnabled": true,
  "SMSPhoneNumber": "sample string 2",
  "PhoneCarrierId": 1
}