Credit

The Credit API method posts points in the member’s account for an activity performed outside the Frankly Media Platform

Parameters

  • memberID– Unique identifier of the member record used by Frankly Media internally
  • code– Numeric identifier of the activity for which the points are credited. The activity codes a provided by Frankly Media
  • partnerName – Unique identifier of the 3rd party calling the API. This information must be requested from Frankly Media in order to use any API methods
  • token – An encrypted string constructed using the passed-in parameters and the partner-specific “shared secret” provided by the Frankly Media. Unless requested differently by the partner, the MD5 hashing algorithm is used to produce the token. For the purpose of this call the following formula should be used: md5(memberID+ code+ points + description+ siteID + timestamp + shared secret). For the generic example refer to this article.
  • points (Optional) If the number of points is not specified, the member will receive the default amount configured by Frankly Media for this activity. Set 0 as default.
  • description (Optional) Describes an instance of the activity. The character limit is 150. Set to 0 as default
  • siteID– Unique identifier of the site in the Frankly Media database. String literals are interpreted as station call letter. Request the ID(s) from the FM support.
  • timestampVerification timestamp. UTC time of the client call. Must be in the following format: YYYYMMDDHHmmss

How to call

URL Format:
https://api.enticent.com/Subscriptions.svc/Credit/{memberID}/{code}/{partnerName}/{token}/{points}/{description}/{siteID}/{timestamp}
https://api.enticent.com/Subscriptions.svc/Credit/2383/12/v2od2o/1E-BE-99-58-31-4E-E6-F0-49-9D-1B-75-5B-A2-75-27/0/0/457/20100505145523

Return Value

If the points are posted successfully, the service returns the receipt in the following format:

<receipt xmlns="http://schemas.datacontract.org/2004/07/ListenerAPI.DataObjects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<totalpoints>198340</totalpoints>
<credit>10</credit>
</receipt>

The receipt contains the total number of points in the member’s account and the number of points credited in this transaction.

Remarks

NOTE: When posting points for correctly answered listening appointments, the appointment ID must be provided in the Description parameter