SubmitOnAir
The SubmitOnAir API method allows one to submit on-air entries to the FM database.
Parameters
• partnerCode – Required. Partner identifier issued by Frankly Media
• siteCode – Required. Used for the token generation. Partner’s unique identifier of the site
• memberID – Unique ID of the member in the FM database.
• answerCodeWord – The participant’s on-air entry.
• timestamp – Verification timestamp. UTC time of the client call. Must be in the following format: YYYYMMDDHHmmss
• 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(partnerCode + siteCode + memberID + answerCodeWord + timeStamp + shared secret).
How to call
This request is an http GET. The contenttype attribute must be set to application/XML. Items in the URL should be correctly URL encoded and you must use %20 for spaces instead of a + sign. The URL of the GET must be in the following format:
https://api.enticent.com/SubmitOnAir/{partnerCode}/{siteCode}/{memberID}/{answerCodeWord}/{timeStamp}/{token}
Return value
<SubmitOnAirResponse xmlns=”http://schemas.datacontract.org/2004/07/ListenerAPI.DataObjects” xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”>
<Status>FAILED</Status>
<MemberID i:nil=”true”/>
<Message>Call expired</Message>
<StatusCode>500</StatusCode>
<Points>0</Points>
<TotalPoints>0</TotalPoints>
</SubmitOnAirResponse>
Status: “SUCCESS” or “FAILED”
StatusCode: 200, 400 or 500 (200 means no errors, it was successfully processed. 400 means client error, and 500 means system error)
Message: error message
MemberID: will be filled if it was successfully processed. And this is the FM member id you may want to hold on for future use.
Points: Number of points earned by participant if the answer was correct and the call was successful.
TotalPoints: Participant’s total points, includes any currently earned Points from above.
Remarks
Items in the URL should be correctly URL encoded. For example, if the answer is “blue bird”, it should be sent as “blue%20bird”.
Examples
See documentation on UpdateMember for example of using PHP to call the API
