Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchHeartbeatRequest
            Public Overridable Property TenantId As Guid?
        End Class

        Public Partial Class DispatchHeartbeatResponse
            Public Overridable Property Tenants As Integer
            Public Overridable Property Tickets As Integer
            Public Overridable Property Releases As Integer
            Public Overridable Property PingsCascaded As Integer
            Public Overridable Property OffersExpired As Integer
            Public Overridable Property WitnessTenants As Integer
            Public Overridable Property WitnessOffersMade As Integer
            Public Overridable Property WitnessOffersExpired As Integer
            Public Overridable Property WitnessErrors As List(Of String) = New List(Of String)
            Public Overridable Property DiningReminders As Integer
            Public Overridable Property ThreadsScheduled As Integer
            Public Overridable Property ThreadsClosed As Integer
            Public Overridable Property RoleChanges As Integer
            Public Overridable Property RoleReleases As Integer
            Public Overridable Property OfferPushes As Integer
            Public Overridable Property CourierTenants As Integer
            Public Overridable Property CourierOffers As Integer
            Public Overridable Property CourierHeld As Integer
            Public Overridable Property CourierLapsed As Integer
            Public Overridable Property CourierBooked As Integer
            Public Overridable Property CourierErrors As List(Of String) = New List(Of String)
            Public Overridable Property WorkPhotosPurged As Integer
            Public Overridable Property SmsMessagesPurged As Integer
            Public Overridable Property SecretsRewritten As Integer
            Public Overridable Property Results As List(Of DispatchHeartbeatTenantResult) = New List(Of DispatchHeartbeatTenantResult)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchHeartbeatTenantResult
            Public Overridable Property TenantId As Guid
            Public Overridable Property Tickets As Integer
            Public Overridable Property Releases As Integer
            Public Overridable Property PingsCascaded As Integer
            Public Overridable Property OffersExpired As Integer
            Public Overridable Property [Error] As String
        End Class
    End Namespace
End Namespace

VB.NET 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>