Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
"use strict";
export class DispatchHeartbeatTenantResult {
    /** @param {{TenantId?:string,Tickets?:number,Releases?:number,PingsCascaded?:number,OffersExpired?:number,Error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TenantId;
    /** @type {number} */
    Tickets;
    /** @type {number} */
    Releases;
    /** @type {number} */
    PingsCascaded;
    /** @type {number} */
    OffersExpired;
    /** @type {string} */
    Error;
}
export class DispatchHeartbeatResponse {
    /** @param {{Tenants?:number,Tickets?:number,Releases?:number,PingsCascaded?:number,OffersExpired?:number,WitnessTenants?:number,WitnessOffersMade?:number,WitnessOffersExpired?:number,WitnessErrors?:string[],DiningReminders?:number,ThreadsScheduled?:number,ThreadsClosed?:number,RoleChanges?:number,RoleReleases?:number,OfferPushes?:number,CourierTenants?:number,CourierOffers?:number,CourierHeld?:number,CourierLapsed?:number,CourierBooked?:number,CourierErrors?:string[],WorkPhotosPurged?:number,SmsMessagesPurged?:number,SecretsRewritten?:number,Results?:DispatchHeartbeatTenantResult[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Tenants;
    /** @type {number} */
    Tickets;
    /** @type {number} */
    Releases;
    /** @type {number} */
    PingsCascaded;
    /** @type {number} */
    OffersExpired;
    /** @type {number} */
    WitnessTenants;
    /** @type {number} */
    WitnessOffersMade;
    /** @type {number} */
    WitnessOffersExpired;
    /** @type {string[]} */
    WitnessErrors = [];
    /** @type {number} */
    DiningReminders;
    /** @type {number} */
    ThreadsScheduled;
    /** @type {number} */
    ThreadsClosed;
    /** @type {number} */
    RoleChanges;
    /** @type {number} */
    RoleReleases;
    /** @type {number} */
    OfferPushes;
    /** @type {number} */
    CourierTenants;
    /** @type {number} */
    CourierOffers;
    /** @type {number} */
    CourierHeld;
    /** @type {number} */
    CourierLapsed;
    /** @type {number} */
    CourierBooked;
    /** @type {string[]} */
    CourierErrors = [];
    /** @type {number} */
    WorkPhotosPurged;
    /** @type {number} */
    SmsMessagesPurged;
    /** @type {number} */
    SecretsRewritten;
    /** @type {DispatchHeartbeatTenantResult[]} */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchHeartbeatRequest {
    /** @param {{TenantId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    TenantId;
}

JavaScript DispatchHeartbeatRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"TenantId":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}