Trendsic Platform Service

<back to all web services

ChatRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/Chat/{ChatId}
GET,POST,OPTIONS/v1/Chat
ChatRequest Parameters:
NameParameterData TypeRequiredDescription
ChatIdpathGuidNo
ChatbodyChatNo
Chat Parameters:
NameParameterData TypeRequiredDescription
ChatIdformGuidNo
ChatNameformstringNo
CreatedByformGuidNo
DateCreatedformDateTimeNo
ChatMembersformList<ChatMember>No
IsArchivedformboolNo
MemberCountformintNo
MessageCountformintNo
UnreadCountformintNo
CreatedByNameformstringNo
ChatMember Parameters:
NameParameterData TypeRequiredDescription
ChatMemberIdformGuidNo
ChatIdformGuidNo
UserIdformGuidNo
IsActiveformboolNo
IsArchivedformboolNo
LastChatMessageIdformGuidNo
ChatMemberNameformstringNo
ChatResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ChatformList<Chat>No

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 /v1/Chat HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ChatId":"00000000000000000000000000000000","Chat":{"ChatId":"00000000000000000000000000000000","ChatName":"String","CreatedBy":"00000000000000000000000000000000","DateCreated":"0001-01-01T00:00:00.0000000","ChatMembers":[{"ChatMemberId":"00000000000000000000000000000000","ChatId":"00000000000000000000000000000000","UserId":"00000000000000000000000000000000","IsActive":false,"IsArchived":false,"LastChatMessageId":"00000000000000000000000000000000","ChatMemberName":"String"}],"IsArchived":false,"MemberCount":0,"MessageCount":0,"UnreadCount":0,"CreatedByName":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Chat":[{"ChatId":"00000000000000000000000000000000","ChatName":"String","CreatedBy":"00000000000000000000000000000000","DateCreated":"0001-01-01T00:00:00.0000000","ChatMembers":[{"ChatMemberId":"00000000000000000000000000000000","ChatId":"00000000000000000000000000000000","UserId":"00000000000000000000000000000000","IsActive":false,"IsArchived":false,"LastChatMessageId":"00000000000000000000000000000000","ChatMemberName":"String"}],"IsArchived":false,"MemberCount":0,"MessageCount":0,"UnreadCount":0,"CreatedByName":"String"}]}