Trendsic Platform Service

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.*


open class DispatchHeartbeatRequest
{
    open var TenantId:UUID? = null
}

open class DispatchHeartbeatResponse
{
    open var Tenants:Int? = null
    open var Tickets:Int? = null
    open var Releases:Int? = null
    open var PingsCascaded:Int? = null
    open var OffersExpired:Int? = null
    open var WitnessTenants:Int? = null
    open var WitnessOffersMade:Int? = null
    open var WitnessOffersExpired:Int? = null
    open var WitnessErrors:ArrayList<String> = ArrayList<String>()
    open var DiningReminders:Int? = null
    open var ThreadsScheduled:Int? = null
    open var ThreadsClosed:Int? = null
    open var RoleChanges:Int? = null
    open var RoleReleases:Int? = null
    open var OfferPushes:Int? = null
    open var CourierTenants:Int? = null
    open var CourierOffers:Int? = null
    open var CourierHeld:Int? = null
    open var CourierLapsed:Int? = null
    open var CourierBooked:Int? = null
    open var CourierErrors:ArrayList<String> = ArrayList<String>()
    open var WorkPhotosPurged:Int? = null
    open var SmsMessagesPurged:Int? = null
    open var SecretsRewritten:Int? = null
    open var Results:ArrayList<DispatchHeartbeatTenantResult> = ArrayList<DispatchHeartbeatTenantResult>()
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchHeartbeatTenantResult
{
    open var TenantId:UUID? = null
    open var Tickets:Int? = null
    open var Releases:Int? = null
    open var PingsCascaded:Int? = null
    open var OffersExpired:Int? = null
    open var Error:String? = null
}

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