Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DispatchHeartbeatRequest
    {
        public UUID TenantId = null;
        
        public UUID getTenantId() { return TenantId; }
        public DispatchHeartbeatRequest setTenantId(UUID value) { this.TenantId = value; return this; }
    }

    public static class DispatchHeartbeatResponse
    {
        public Integer Tenants = null;
        public Integer Tickets = null;
        public Integer Releases = null;
        public Integer PingsCascaded = null;
        public Integer OffersExpired = null;
        public Integer WitnessTenants = null;
        public Integer WitnessOffersMade = null;
        public Integer WitnessOffersExpired = null;
        public ArrayList<String> WitnessErrors = new ArrayList<String>();
        public Integer DiningReminders = null;
        public Integer ThreadsScheduled = null;
        public Integer ThreadsClosed = null;
        public Integer RoleChanges = null;
        public Integer RoleReleases = null;
        public Integer OfferPushes = null;
        public Integer CourierTenants = null;
        public Integer CourierOffers = null;
        public Integer CourierHeld = null;
        public Integer CourierLapsed = null;
        public Integer CourierBooked = null;
        public ArrayList<String> CourierErrors = new ArrayList<String>();
        public Integer WorkPhotosPurged = null;
        public Integer SmsMessagesPurged = null;
        public Integer SecretsRewritten = null;
        public ArrayList<DispatchHeartbeatTenantResult> Results = new ArrayList<DispatchHeartbeatTenantResult>();
        public ResponseStatus ResponseStatus = null;
        
        public Integer getTenants() { return Tenants; }
        public DispatchHeartbeatResponse setTenants(Integer value) { this.Tenants = value; return this; }
        public Integer getTickets() { return Tickets; }
        public DispatchHeartbeatResponse setTickets(Integer value) { this.Tickets = value; return this; }
        public Integer getReleases() { return Releases; }
        public DispatchHeartbeatResponse setReleases(Integer value) { this.Releases = value; return this; }
        public Integer getPingsCascaded() { return PingsCascaded; }
        public DispatchHeartbeatResponse setPingsCascaded(Integer value) { this.PingsCascaded = value; return this; }
        public Integer getOffersExpired() { return OffersExpired; }
        public DispatchHeartbeatResponse setOffersExpired(Integer value) { this.OffersExpired = value; return this; }
        public Integer getWitnessTenants() { return WitnessTenants; }
        public DispatchHeartbeatResponse setWitnessTenants(Integer value) { this.WitnessTenants = value; return this; }
        public Integer getWitnessOffersMade() { return WitnessOffersMade; }
        public DispatchHeartbeatResponse setWitnessOffersMade(Integer value) { this.WitnessOffersMade = value; return this; }
        public Integer getWitnessOffersExpired() { return WitnessOffersExpired; }
        public DispatchHeartbeatResponse setWitnessOffersExpired(Integer value) { this.WitnessOffersExpired = value; return this; }
        public ArrayList<String> getWitnessErrors() { return WitnessErrors; }
        public DispatchHeartbeatResponse setWitnessErrors(ArrayList<String> value) { this.WitnessErrors = value; return this; }
        public Integer getDiningReminders() { return DiningReminders; }
        public DispatchHeartbeatResponse setDiningReminders(Integer value) { this.DiningReminders = value; return this; }
        public Integer getThreadsScheduled() { return ThreadsScheduled; }
        public DispatchHeartbeatResponse setThreadsScheduled(Integer value) { this.ThreadsScheduled = value; return this; }
        public Integer getThreadsClosed() { return ThreadsClosed; }
        public DispatchHeartbeatResponse setThreadsClosed(Integer value) { this.ThreadsClosed = value; return this; }
        public Integer getRoleChanges() { return RoleChanges; }
        public DispatchHeartbeatResponse setRoleChanges(Integer value) { this.RoleChanges = value; return this; }
        public Integer getRoleReleases() { return RoleReleases; }
        public DispatchHeartbeatResponse setRoleReleases(Integer value) { this.RoleReleases = value; return this; }
        public Integer getOfferPushes() { return OfferPushes; }
        public DispatchHeartbeatResponse setOfferPushes(Integer value) { this.OfferPushes = value; return this; }
        public Integer getCourierTenants() { return CourierTenants; }
        public DispatchHeartbeatResponse setCourierTenants(Integer value) { this.CourierTenants = value; return this; }
        public Integer getCourierOffers() { return CourierOffers; }
        public DispatchHeartbeatResponse setCourierOffers(Integer value) { this.CourierOffers = value; return this; }
        public Integer getCourierHeld() { return CourierHeld; }
        public DispatchHeartbeatResponse setCourierHeld(Integer value) { this.CourierHeld = value; return this; }
        public Integer getCourierLapsed() { return CourierLapsed; }
        public DispatchHeartbeatResponse setCourierLapsed(Integer value) { this.CourierLapsed = value; return this; }
        public Integer getCourierBooked() { return CourierBooked; }
        public DispatchHeartbeatResponse setCourierBooked(Integer value) { this.CourierBooked = value; return this; }
        public ArrayList<String> getCourierErrors() { return CourierErrors; }
        public DispatchHeartbeatResponse setCourierErrors(ArrayList<String> value) { this.CourierErrors = value; return this; }
        public Integer getWorkPhotosPurged() { return WorkPhotosPurged; }
        public DispatchHeartbeatResponse setWorkPhotosPurged(Integer value) { this.WorkPhotosPurged = value; return this; }
        public Integer getSmsMessagesPurged() { return SmsMessagesPurged; }
        public DispatchHeartbeatResponse setSmsMessagesPurged(Integer value) { this.SmsMessagesPurged = value; return this; }
        public Integer getSecretsRewritten() { return SecretsRewritten; }
        public DispatchHeartbeatResponse setSecretsRewritten(Integer value) { this.SecretsRewritten = value; return this; }
        public ArrayList<DispatchHeartbeatTenantResult> getResults() { return Results; }
        public DispatchHeartbeatResponse setResults(ArrayList<DispatchHeartbeatTenantResult> value) { this.Results = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DispatchHeartbeatResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DispatchHeartbeatTenantResult
    {
        public UUID TenantId = null;
        public Integer Tickets = null;
        public Integer Releases = null;
        public Integer PingsCascaded = null;
        public Integer OffersExpired = null;
        public String Error = null;
        
        public UUID getTenantId() { return TenantId; }
        public DispatchHeartbeatTenantResult setTenantId(UUID value) { this.TenantId = value; return this; }
        public Integer getTickets() { return Tickets; }
        public DispatchHeartbeatTenantResult setTickets(Integer value) { this.Tickets = value; return this; }
        public Integer getReleases() { return Releases; }
        public DispatchHeartbeatTenantResult setReleases(Integer value) { this.Releases = value; return this; }
        public Integer getPingsCascaded() { return PingsCascaded; }
        public DispatchHeartbeatTenantResult setPingsCascaded(Integer value) { this.PingsCascaded = value; return this; }
        public Integer getOffersExpired() { return OffersExpired; }
        public DispatchHeartbeatTenantResult setOffersExpired(Integer value) { this.OffersExpired = value; return this; }
        public String getError() { return Error; }
        public DispatchHeartbeatTenantResult setError(String value) { this.Error = value; return this; }
    }

}

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