Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

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

export class DispatchHeartbeatTenantResult
{
    public TenantId: string;
    public Tickets: number;
    public Releases: number;
    public PingsCascaded: number;
    public OffersExpired: number;
    public Error: string;

    public constructor(init?: Partial<DispatchHeartbeatTenantResult>) { (Object as any).assign(this, init); }
}

export class DispatchHeartbeatResponse
{
    public Tenants: number;
    public Tickets: number;
    public Releases: number;
    public PingsCascaded: number;
    public OffersExpired: number;
    public WitnessTenants: number;
    public WitnessOffersMade: number;
    public WitnessOffersExpired: number;
    public WitnessErrors: string[] = [];
    public DiningReminders: number;
    public ThreadsScheduled: number;
    public ThreadsClosed: number;
    public RoleChanges: number;
    public RoleReleases: number;
    public OfferPushes: number;
    public CourierTenants: number;
    public CourierOffers: number;
    public CourierHeld: number;
    public CourierLapsed: number;
    public CourierBooked: number;
    public CourierErrors: string[] = [];
    public WorkPhotosPurged: number;
    public SmsMessagesPurged: number;
    public SecretsRewritten: number;
    public Results: DispatchHeartbeatTenantResult[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchHeartbeatResponse>) { (Object as any).assign(this, init); }
}

export class DispatchHeartbeatRequest
{
    public TenantId?: string;

    public constructor(init?: Partial<DispatchHeartbeatRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchHeartbeatRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

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