WebAPI/SimplePush: Difference between revisions

WebAPI/SimplePush (view source)

661 bytes added , 8 January 2013

Confirmed users

93

edits

@@ Line 171: / Line 171: @@
 ===== Returns =====
-This will return a hash containing a list of hashes defining the known, associated Channels and versions.
+The server should return an object with the following fields:
-NOTE: If the server is unable to determine previous data for this X-UserAgent-ID, it will return a 410.
+* <tt>digest</tt> - This will return a digest of the known ChannelIDs for the calling User Agent. This digest is used as a checksum to ensure UA and Push Server have the same state. If a mismatch occurs, it is resolved using the Registration Sync Protocol.
+* <tt>updates</tt> - An association of ChannelIDs and versions that have changed since the last time the UA called /update.
+* <tt>expired</tt> - A list of ChannelIDs which have expired. The UA should remove these from its own database, and ask applications to re-register.
+'''TODO''' Do we need acknowledgement of the /update from the UA. It is possible for the response to be lost in flight.
+NOTE: If the server is unable to determine previous data for this X-UserAgent-ID, it will return a 410 leading to the Registration Sync Protocol occurring.
 See <code>POST /update</code> for details.
 ===== Example =====