Trendsic Platform Service

<back to all web services

ContactCommunicationsByHeaderRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Communications/{ConversationHeaderId}

export class ContactCommunication
{
    public ContactId: number;
    public ContactName: string;
    public AgentId: number;
    public AgentName: string;
    public DateCreated: string;
    public Message: string;
    public MessageType: string;
    public IsAgentMessage: boolean;
    public Sender: string;

    public constructor(init?: Partial<ContactCommunication>) { (Object as any).assign(this, init); }
}

export class ContactCommunicationsResponse
{
    public ResponseStatus: ResponseStatus;
    public Communications: ContactCommunication[] = [];

    public constructor(init?: Partial<ContactCommunicationsResponse>) { (Object as any).assign(this, init); }
}

export class ContactCommunicationsByHeaderRequest
{
    public ConversationHeaderId: string;

    public constructor(init?: Partial<ContactCommunicationsByHeaderRequest>) { (Object as any).assign(this, init); }
}

TypeScript ContactCommunicationsByHeaderRequest DTOs

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.

GET /v1/Communications/{ConversationHeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
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"}},"Communications":[{"ContactId":0,"ContactName":"String","AgentId":0,"AgentName":"String","DateCreated":"0001-01-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}