Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
DispatchHeartbeatRequest Parameters:
NameParameterData TypeRequiredDescription
TenantIdbodyGuid?No
DispatchHeartbeatResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsformintNo
TicketsformintNo
ReleasesformintNo
PingsCascadedformintNo
OffersExpiredformintNo
WitnessTenantsformintNo
WitnessOffersMadeformintNo
WitnessOffersExpiredformintNo
WitnessErrorsformList<string>No
DiningRemindersformintNo
ThreadsScheduledformintNo
ThreadsClosedformintNo
RoleChangesformintNo
RoleReleasesformintNo
OfferPushesformintNo
CourierTenantsformintNo
CourierOffersformintNo
CourierHeldformintNo
CourierLapsedformintNo
CourierBookedformintNo
CourierErrorsformList<string>No
WorkPhotosPurgedformintNo
SmsMessagesPurgedformintNo
SecretsRewrittenformintNo
ResultsformList<DispatchHeartbeatTenantResult>No
ResponseStatusformResponseStatusNo
DispatchHeartbeatTenantResult Parameters:
NameParameterData TypeRequiredDescription
TenantIdformGuidNo
TicketsformintNo
ReleasesformintNo
PingsCascadedformintNo
OffersExpiredformintNo
ErrorformstringNo

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
		}
	}
}