canmove, Confirmed users
1,173
edits
Services/Sync/Server/Archived/0.3/API: Difference between revisions
Jump to navigation
Jump to search
Services/Sync/Server/Archived/0.3/API (view source)
Revision as of 17:39, 9 October 2008
, 9 October 2008→Weave Basic Object (WBO)
m (→Sample:) |
|||
| Line 8: | Line 8: | ||
|- style="background-color: #efefef;" | |- style="background-color: #efefef;" | ||
| style="background-color: #efefef;" | '''Parameter''' | | style="background-color: #efefef;" | '''Parameter''' | ||
| style="background-color: #efefef; width: 100px" | '''Default''' | | style="background-color: #efefef; width: 100px" | '''Default''' | '''Max''' | ||
| '''Description''' | | '''Description''' | ||
|- valign="top" | |- valign="top" | ||
| id | | id | ||
| required | | required | ||
| 32 | |||
| An identifying string. For a user, the id must be unique for a WBO within a collection, though objects in different collections may have the same ID. | | An identifying string. For a user, the id must be unique for a WBO within a collection, though objects in different collections may have the same ID. | ||
|- valign="top" | |- valign="top" | ||
| type | | type | ||
| none | | none | ||
| 32 | |||
| A hint to the system as to the type of object contained in the WBO payload. | | A hint to the system as to the type of object contained in the WBO payload. | ||
|- valign="top" | |- valign="top" | ||
| parentid | | parentid | ||
| none | | none | ||
| 32 | |||
| The id of a parent object in the same collection. This allows for the creation of hierarchical structures (such as folders). | | The id of a parent object in the same collection. This allows for the creation of hierarchical structures (such as folders). | ||
|- valign="top" | |- valign="top" | ||
| modified | | modified | ||
| time submitted | | time submitted | ||
| 16 | |||
| The last-modified date, in Julian date format. | | The last-modified date, in Julian date format. | ||
|- valign="top" | |- valign="top" | ||
| encryption | | encryption | ||
| none | | none | ||
| 256 | |||
| The URL of a Weave Encryption Record (WER) that defines how the payload is encrypted. No URL means that the payload is being sent unencrypted. | | The URL of a Weave Encryption Record (WER) that defines how the payload is encrypted. No URL means that the payload is being sent unencrypted. | ||
|- valign="top" | |- valign="top" | ||
| encoding | | encoding | ||
| utf-8 | | utf-8 | ||
| 16 | |||
| The character set of the decrypted payload. | | The character set of the decrypted payload. | ||
payload (required) - The (possibly encrypted) JSON structure encapsualting the data of the record. This structure is defined separately for each WBO type. | payload (required) - The (possibly encrypted) JSON structure encapsualting the data of the record. This structure is defined separately for each WBO type. | ||