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 .xml suffix or ?format=xml

HTTP + XML

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

<DispatchHeartbeatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
</DispatchHeartbeatRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchHeartbeatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CourierBooked>0</CourierBooked>
  <CourierErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CourierErrors>
  <CourierHeld>0</CourierHeld>
  <CourierLapsed>0</CourierLapsed>
  <CourierOffers>0</CourierOffers>
  <CourierTenants>0</CourierTenants>
  <DiningReminders>0</DiningReminders>
  <OfferPushes>0</OfferPushes>
  <OffersExpired>0</OffersExpired>
  <PingsCascaded>0</PingsCascaded>
  <Releases>0</Releases>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <DispatchHeartbeatTenantResult>
      <Error>String</Error>
      <OffersExpired>0</OffersExpired>
      <PingsCascaded>0</PingsCascaded>
      <Releases>0</Releases>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <Tickets>0</Tickets>
    </DispatchHeartbeatTenantResult>
  </Results>
  <RoleChanges>0</RoleChanges>
  <RoleReleases>0</RoleReleases>
  <SecretsRewritten>0</SecretsRewritten>
  <SmsMessagesPurged>0</SmsMessagesPurged>
  <Tenants>0</Tenants>
  <ThreadsClosed>0</ThreadsClosed>
  <ThreadsScheduled>0</ThreadsScheduled>
  <Tickets>0</Tickets>
  <WitnessErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </WitnessErrors>
  <WitnessOffersExpired>0</WitnessOffersExpired>
  <WitnessOffersMade>0</WitnessOffersMade>
  <WitnessTenants>0</WitnessTenants>
  <WorkPhotosPurged>0</WorkPhotosPurged>
</DispatchHeartbeatResponse>