Name Patterns
All external class names begin with the letter X, followed by the version number, followed by a noun (for example, Conversation, Message, or People), followed by one or more modifiers, depending on the function of the class.
The following table describes the class name conventions and the associated functions, using the Conversation resource type as an example.
| XV1Conversation. . . | Action |
|---|---|
| Info | Get information about a Conversation (GET). |
| CreateInfo | Create a Conversation and set properties (POST). |
| FilterInfo | Get Conversations that meet the filter criteria (GET). |
| MemberCreateInfo | Add a member to a Conversation and set properties (POST). |
| MemberInfo | Get information about a member of a Conversation (GET). |
| MessageCreateInfo | Add a message in a Conversation (POST). |
| PropertyCreateInfo | Set properties for a Conversation (POST). |
| PropertyInfo | Get a property for an existing Conversation (GET). |
| PropertyUpdateInfo | Set a property for a Conversation (PUT). |
| UpdateInfo | Update attributes for a Conversation (PUT). |
| ListInfo | Get a list of all Conversations (GET). |
| MemberListInfo | Get a list of all direct members of the Conversation (GET). |
| PropertyListInfo | Get a list of all properties for the Conversation (GET) . |
| StarListInfo | Get a list of starred Conversations and their messages (GET) . |
XObjectID
Each object in the REST API for Conversations has a unique ID. From that ID, you can load the object, if you have sufficient permissions. Many data transfer objects (DTOs) specify IDs of other objects related to the current object. Some examples include ParentID, ModifiedByUserID, CreatedByUserID, and ConversationID. These are all links or references to other objects in the system.
Note that the ID parameter represents a name for fields, an ObjectID or an External ID for Conversation objects, and an Object ID or sign in name for users.