Confirmed users
99
edits
Raindrop/WebApis/inflow: Difference between revisions
more sections adjustment
(link to create_identity_relationships docs) |
(more sections adjustment) |
||
| Line 174: | Line 174: | ||
* '''relationship''': The relationship between the identity and the contact. For example, if the identity ID specifies a phone number, the relationship might be "home" or "office". If it is an email address, it may be the generic "email", or possibly some other identifier. See the [[Raindrop/WebApis/model#create_identity_relationships_method]] for more information. | * '''relationship''': The relationship between the identity and the contact. For example, if the identity ID specifies a phone number, the relationship might be "home" or "office". If it is an email address, it may be the generic "email", or possibly some other identifier. See the [[Raindrop/WebApis/model#create_identity_relationships_method]] for more information. | ||
== API response objects == | |||
=== Conversation object === | |||
Many API calls return one or many (ie, an array of) conversation objects. A Conversation object has the following properties: | Many API calls return one or many (ie, an array of) conversation objects. A Conversation object has the following properties: | ||
| Line 191: | Line 191: | ||
* '''messages''': An array of [[#Message object]]s. This will generally ''not'' be the full set of messages in the conversation, but a selected set, each with a selected set of schemas. Most API calls have request parameters which determine the list of messages and schemas in this element. | * '''messages''': An array of [[#Message object]]s. This will generally ''not'' be the full set of messages in the conversation, but a selected set, each with a selected set of schemas. Most API calls have request parameters which determine the list of messages and schemas in this element. | ||
=== Message object === | |||
A message is represented using an object with the following elements. | A message is represented using an object with the following elements. | ||
| Line 199: | Line 199: | ||
* '''attachments''': An array [[[#Attachment object]] summaries for all 'attachments' in a message. The concept of an attachment is quite broad, so includes things like hyperlinks parsed from the messages. The '''attachments''' namespace calls can be used to fetch the details of each attachment. Each attachment will have null as the value for each schema (hence it is referred to as an attachment summary) | * '''attachments''': An array [[[#Attachment object]] summaries for all 'attachments' in a message. The concept of an attachment is quite broad, so includes things like hyperlinks parsed from the messages. The '''attachments''' namespace calls can be used to fetch the details of each attachment. Each attachment will have null as the value for each schema (hence it is referred to as an attachment summary) | ||
=== Attachment object === | |||
An attachment is represented using an object with the following elements. | An attachment is represented using an object with the following elements. | ||