<back to all web services
Conversation
The following routes are available for this service:| GET,POST | /{Workspace}/Conversation | | |
|---|
| GET | /{Workspace}/Conversation/{ObjectId} | | |
|---|
| GET | /{Workspace}/Conversation/Search/{MemberId} | | |
|---|
| GET | /{Workspace}/Conversation/Search/{SearchType}/{SearchText} | | |
|---|
Conversation Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | path | string | No | |
| Workspace | path | string | No | |
| TeamId | body | string | No | |
| Members | body | List<string> | No | |
| Events | body | List<ConversationEvent> | No | |
| Unread | body | long | No | |
| MemberId | path | string | No | |
| SearchType | path | string | No | |
| SearchText | path | string | No | |
ConversationEvent Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Workspace | form | string | No | |
| Date | form | string | No | |
| ConversationId | form | string | No | |
| UserId | form | string | No | |
| Text | form | string | No | |
| ThumbnailId | form | string | No | |
| IsLink | form | bool | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /{Workspace}/Conversation HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Conversation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Messaging">
<Events>
<ConversationEvent>
<ConversationId>String</ConversationId>
<Date>String</Date>
<IsLink>false</IsLink>
<ObjectId>String</ObjectId>
<Text>String</Text>
<ThumbnailId>String</ThumbnailId>
<UserId>String</UserId>
<Workspace>String</Workspace>
</ConversationEvent>
</Events>
<MemberId>String</MemberId>
<Members xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Members>
<ObjectId>String</ObjectId>
<SearchText>String</SearchText>
<SearchType>String</SearchType>
<TeamId>String</TeamId>
<Unread>0</Unread>
<Workspace>String</Workspace>
</Conversation>