Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchHeartbeatRequest
    {
        public virtual Guid? TenantId { get; set; }
    }

    public partial class DispatchHeartbeatResponse
    {
        public virtual int Tenants { get; set; }
        public virtual int Tickets { get; set; }
        public virtual int Releases { get; set; }
        public virtual int PingsCascaded { get; set; }
        public virtual int OffersExpired { get; set; }
        public virtual List<DispatchHeartbeatTenantResult> Results { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchHeartbeatTenantResult
    {
        public virtual Guid TenantId { get; set; }
        public virtual int Tickets { get; set; }
        public virtual int Releases { get; set; }
        public virtual int PingsCascaded { get; set; }
        public virtual int OffersExpired { get; set; }
        public virtual string Error { get; set; }
    }

}

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

{
	TenantId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}