Trendsic Platform Service

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/heartbeat

import Foundation
import ServiceStack

public class DispatchHeartbeatRequest : Codable
{
    public var tenantId:String?

    required public init(){}
}

public class DispatchHeartbeatResponse : Codable
{
    public var tenants:Int
    public var tickets:Int
    public var releases:Int
    public var pingsCascaded:Int
    public var offersExpired:Int
    public var witnessTenants:Int
    public var witnessOffersMade:Int
    public var witnessOffersExpired:Int
    public var witnessErrors:[String] = []
    public var diningReminders:Int
    public var threadsScheduled:Int
    public var threadsClosed:Int
    public var roleChanges:Int
    public var roleReleases:Int
    public var offerPushes:Int
    public var courierTenants:Int
    public var courierOffers:Int
    public var courierHeld:Int
    public var courierLapsed:Int
    public var courierBooked:Int
    public var courierErrors:[String] = []
    public var workPhotosPurged:Int
    public var smsMessagesPurged:Int
    public var secretsRewritten:Int
    public var results:[DispatchHeartbeatTenantResult] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchHeartbeatTenantResult : Codable
{
    public var tenantId:String
    public var tickets:Int
    public var releases:Int
    public var pingsCascaded:Int
    public var offersExpired:Int
    public var error:String

    required public init(){}
}

Swift 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,
	WitnessTenants: 0,
	WitnessOffersMade: 0,
	WitnessOffersExpired: 0,
	WitnessErrors: 
	[
		String
	],
	DiningReminders: 0,
	ThreadsScheduled: 0,
	ThreadsClosed: 0,
	RoleChanges: 0,
	RoleReleases: 0,
	OfferPushes: 0,
	CourierTenants: 0,
	CourierOffers: 0,
	CourierHeld: 0,
	CourierLapsed: 0,
	CourierBooked: 0,
	CourierErrors: 
	[
		String
	],
	WorkPhotosPurged: 0,
	SmsMessagesPurged: 0,
	SecretsRewritten: 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
		}
	}
}