109
edits
Raindrop/WebApis/inflow: Difference between revisions
Jump to navigation
Jump to search
→Contacts
(more sections adjustment) |
|||
| Line 138: | Line 138: | ||
== Contacts == | == Contacts == | ||
The 'contacts' namespace is used to access information regarding contacts and (indirectly) identities | The 'contacts' namespace is used to access information regarding contacts and (indirectly) identities | ||
=== recent method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/recent''' | |||
Returns recent contacts, where recent is defined as the people who the user has sent messages to recently. | |||
==== Request Params ==== | |||
* '''limit''': The maximum number of items to return | |||
* '''skip''': The number of items to skop | |||
==== Response ==== | |||
An array of [http://portablecontacts.net/draft-spec.html Portable Contacts] objects. | |||
=== frequent method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/frequent''' | |||
Returns frequent contacts, where frequent is defined as the people who the user has sent messages to frequently. | |||
==== Request Params ==== | |||
* '''limit''': The maximum number of items to return | |||
* '''skip''': The number of items to skop | |||
==== Response ==== | |||
An array of [http://portablecontacts.net/draft-spec.html Portable Contacts] objects. | |||
=== lookup method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/lookup''' | |||
Returns one or more contacts, based on contact ID. | |||
==== Request Params ==== | |||
* '''id''': The contact ID to return. Multiple id parameters can be passed to fetch more than one contact. | |||
==== Response ==== | |||
An array of [http://portablecontacts.net/draft-spec.html Portable Contacts] objects. | |||
=== search method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/search''' | |||
Returns one or more contacts, base on some search criteria. If no search criteria is given, all contacts are returned in an unspecified order. | |||
==== Request Params ==== | |||
Fields from the a Portable Contacts API can be used to to search. For the [http://portablecontacts.net/draft-spec.html#anchor17 Plural Fields] only the value can be specified. | |||
Some commmon ones that are used: | |||
* '''displayName''': The contact's displayName | |||
* '''emails''': An comma-separated list of email names that should be used for searching. | |||
For pagination, the following params are allowed: | |||
* '''limit''': The maximum number of items to return | |||
* '''skip''': The number of items to skop | |||
==== Response ==== | |||
An array of [http://portablecontacts.net/draft-spec.html Portable Contacts] objects. | |||
=== update method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/update''' | |||
Updates a contact's information. | |||
==== Request Params ==== | |||
A JSON encoded object that follows the Portable Contacts API. It '''requires''' the presence of an '''id''' property in the object. If there is no id property, it means a new contact is being created, so the '''create''' API should be used instead. | |||
==== Response ==== | |||
The contact ID of the contact that was updated. | |||
=== create method === | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/create''' | |||
Create a contact's information | |||
==== Request Params ==== | |||
A JSON encoded object that follows the Portable Contacts API. | |||
==== Response ==== | |||
The contact ID of the contact that was created. | |||
=== Older methods === | |||
=== by_name method === | === by_name method === | ||