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}
import Foundation
import ServiceStack

public class Conversation : Codable
{
    public var objectId:String
    public var workspace:String
    public var teamId:String
    public var members:[String] = []
    public var events:[ConversationEvent] = []
    public var unread:Int
    public var memberId:String
    public var searchType:String
    public var searchText:String

    required public init(){}
}

public class ConversationEvent : Codable
{
    public var objectId:String
    public var workspace:String
    public var date:String
    public var conversationId:String
    public var userId:String
    public var text:String
    public var thumbnailId:String
    public var isLink:Bool

    required public init(){}
}


Swift Conversation DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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
}