Latest revision as of 21:31, 29 August 2012 (view source) MetrixAdmin (Talk | contribs) (Created page with "= User Cookie Data = User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the...")

---

Latest revision as of 21:31, 29 August 2012

Contents 1 User Cookie Data 1.1 Set User Cookie 1.1.1 Authentication Restrictions 1.1.2 Required Parameters 1.1.3 Successful Response 1.2 Delete User Cookie 1.2.1 Authentication Restrictions 1.2.2 Required Parameters 1.2.3 Successful Response

[edit] User Cookie Data

User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the ability to have them persist across different computers. This means when a user logs in from home and work, the experience will be the same.

The big difference between a user cookie and a browser cookie, is that a user cookie requires an authenticated session.... meaning no anonymous preferences are supported. Note: you are not forced to choose one or the other, so you can mix and match each solution to fit your requirements.

[edit] Set User Cookie

This API call is responsible for setting a user cookie.

[edit] Authentication Restrictions

An authenticated user.

[edit] Required Parameters

• action=usercookie
• verb=set
• name: the name of the user cookie.

this has a maximum of 48 characters.

• value: the value of the user cookie.

this has a maximum of 1000 characters.

[edit] Successful Response

• status=ok

[edit] Delete User Cookie

This API call is responsible for deleting a user cookie. The response will still succeed, if the cookie doesn't exist.

[edit] Authentication Restrictions

This API call is responsible for setting a user cookie.

[edit] Required Parameters

• action=usercookie
• verb=del
• name: the name of the user cookie.

[edit] Successful Response

• status=ok