Field Squared API Services

<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:
NameParameterData TypeRequiredDescription
ObjectIdpathstringNo
WorkspacepathstringNo
TeamIdbodystringNo
MembersbodyList<string>No
EventsbodyList<ConversationEvent>No
UnreadbodylongNo
MemberIdpathstringNo
SearchTypepathstringNo
SearchTextpathstringNo
ConversationEvent Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
WorkspaceformstringNo
DateformstringNo
ConversationIdformstringNo
UserIdformstringNo
TextformstringNo
ThumbnailIdformstringNo
IsLinkformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"String","Workspace":"String","TeamId":"String","Members":["String"],"Events":[{"ObjectId":"String","Workspace":"String","Date":"String","ConversationId":"String","UserId":"String","Text":"String","ThumbnailId":"String","IsLink":false}],"Unread":0,"MemberId":"String","SearchType":"String","SearchText":"String"}