Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
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 DispatchHeartbeatTenantResult() = 
        member val TenantId:Guid = new Guid() with get,set
        member val Tickets:Int32 = new Int32() with get,set
        member val Releases:Int32 = new Int32() with get,set
        member val PingsCascaded:Int32 = new Int32() with get,set
        member val OffersExpired:Int32 = new Int32() with get,set
        member val Error:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchHeartbeatResponse() = 
        member val Tenants:Int32 = new Int32() with get,set
        member val Tickets:Int32 = new Int32() with get,set
        member val Releases:Int32 = new Int32() with get,set
        member val PingsCascaded:Int32 = new Int32() with get,set
        member val OffersExpired:Int32 = new Int32() with get,set
        member val Results:ResizeArray<DispatchHeartbeatTenantResult> = new ResizeArray<DispatchHeartbeatTenantResult>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchHeartbeatRequest() = 
        member val TenantId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# DispatchHeartbeatRequest 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/dispatch/heartbeat HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TenantId":"00000000000000000000000000000000"}

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

{"Tenants":0,"Tickets":0,"Releases":0,"PingsCascaded":0,"OffersExpired":0,"Results":[{"TenantId":"00000000000000000000000000000000","Tickets":0,"Releases":0,"PingsCascaded":0,"OffersExpired":0,"Error":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}