Piper Push Cache Documentation Download Samples Contact  


For consistency in handling results on the websocket connection all data sent will be in JSON format. A special message type is defined that can not be subscribed for sending adminitrative messages. This message includes an element named 'class' and has a value of '_Admin'. The message has elements:

class: The element will always be the string '_Admin'
id: The id field will contain the identifier of the record the messages is referring to. As an example it could be John.
reason: The reason field is the reason for the message such as 'Not Found' or 'Removed'.
msg: The msg field describes in more details the reason for the record being sent. The field may not be present as is the case with 'Removed' records.