Trendsic Platform Service

<back to all web services

Messages

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Messages/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Messages
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MessageObject() = 
        member val Id:Guid = new Guid() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type MessagesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Messages:ResizeArray<MessageObject> = new ResizeArray<MessageObject>() with get,set

    [<AllowNullLiteral>]
    type Messages() = 
        inherit MessageObject()
        member val ApiKey:Guid = new Guid() with get,set

F# Messages 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.

POST /v1/Messages/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","Message":"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"}},"Messages":[{"Id":"00000000000000000000000000000000","Message":"String"}]}