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 int WitnessTenants { get; set; }
        public virtual int WitnessOffersMade { get; set; }
        public virtual int WitnessOffersExpired { get; set; }
        public virtual List<string> WitnessErrors { get; set; } = [];
        public virtual int DiningReminders { get; set; }
        public virtual int ThreadsScheduled { get; set; }
        public virtual int ThreadsClosed { get; set; }
        public virtual int RoleChanges { get; set; }
        public virtual int RoleReleases { get; set; }
        public virtual int OfferPushes { get; set; }
        public virtual int CourierTenants { get; set; }
        public virtual int CourierOffers { get; set; }
        public virtual int CourierHeld { get; set; }
        public virtual int CourierLapsed { get; set; }
        public virtual int CourierBooked { get; set; }
        public virtual List<string> CourierErrors { get; set; } = [];
        public virtual int WorkPhotosPurged { get; set; }
        public virtual int SmsMessagesPurged { get; set; }
        public virtual int SecretsRewritten { 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 .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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