Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
import 'package:servicestack/servicestack.dart';

class DispatchHeartbeatTenantResult implements IConvertible
{
    String? TenantId;
    int? Tickets;
    int? Releases;
    int? PingsCascaded;
    int? OffersExpired;
    String? Error;

    DispatchHeartbeatTenantResult({this.TenantId,this.Tickets,this.Releases,this.PingsCascaded,this.OffersExpired,this.Error});
    DispatchHeartbeatTenantResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TenantId = json['TenantId'];
        Tickets = json['Tickets'];
        Releases = json['Releases'];
        PingsCascaded = json['PingsCascaded'];
        OffersExpired = json['OffersExpired'];
        Error = json['Error'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TenantId': TenantId,
        'Tickets': Tickets,
        'Releases': Releases,
        'PingsCascaded': PingsCascaded,
        'OffersExpired': OffersExpired,
        'Error': Error
    };

    getTypeName() => "DispatchHeartbeatTenantResult";
    TypeContext? context = _ctx;
}

class DispatchHeartbeatResponse implements IConvertible
{
    int? Tenants;
    int? Tickets;
    int? Releases;
    int? PingsCascaded;
    int? OffersExpired;
    int? WitnessTenants;
    int? WitnessOffersMade;
    int? WitnessOffersExpired;
    List<String>? WitnessErrors = [];
    int? DiningReminders;
    int? ThreadsScheduled;
    int? ThreadsClosed;
    int? RoleChanges;
    int? RoleReleases;
    int? OfferPushes;
    int? CourierTenants;
    int? CourierOffers;
    int? CourierHeld;
    int? CourierLapsed;
    int? CourierBooked;
    List<String>? CourierErrors = [];
    int? WorkPhotosPurged;
    int? SmsMessagesPurged;
    int? SecretsRewritten;
    List<DispatchHeartbeatTenantResult>? Results = [];
    ResponseStatus? ResponseStatus;

    DispatchHeartbeatResponse({this.Tenants,this.Tickets,this.Releases,this.PingsCascaded,this.OffersExpired,this.WitnessTenants,this.WitnessOffersMade,this.WitnessOffersExpired,this.WitnessErrors,this.DiningReminders,this.ThreadsScheduled,this.ThreadsClosed,this.RoleChanges,this.RoleReleases,this.OfferPushes,this.CourierTenants,this.CourierOffers,this.CourierHeld,this.CourierLapsed,this.CourierBooked,this.CourierErrors,this.WorkPhotosPurged,this.SmsMessagesPurged,this.SecretsRewritten,this.Results,this.ResponseStatus});
    DispatchHeartbeatResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Tenants = json['Tenants'];
        Tickets = json['Tickets'];
        Releases = json['Releases'];
        PingsCascaded = json['PingsCascaded'];
        OffersExpired = json['OffersExpired'];
        WitnessTenants = json['WitnessTenants'];
        WitnessOffersMade = json['WitnessOffersMade'];
        WitnessOffersExpired = json['WitnessOffersExpired'];
        WitnessErrors = JsonConverters.fromJson(json['WitnessErrors'],'List<String>',context!);
        DiningReminders = json['DiningReminders'];
        ThreadsScheduled = json['ThreadsScheduled'];
        ThreadsClosed = json['ThreadsClosed'];
        RoleChanges = json['RoleChanges'];
        RoleReleases = json['RoleReleases'];
        OfferPushes = json['OfferPushes'];
        CourierTenants = json['CourierTenants'];
        CourierOffers = json['CourierOffers'];
        CourierHeld = json['CourierHeld'];
        CourierLapsed = json['CourierLapsed'];
        CourierBooked = json['CourierBooked'];
        CourierErrors = JsonConverters.fromJson(json['CourierErrors'],'List<String>',context!);
        WorkPhotosPurged = json['WorkPhotosPurged'];
        SmsMessagesPurged = json['SmsMessagesPurged'];
        SecretsRewritten = json['SecretsRewritten'];
        Results = JsonConverters.fromJson(json['Results'],'List<DispatchHeartbeatTenantResult>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Tenants': Tenants,
        'Tickets': Tickets,
        'Releases': Releases,
        'PingsCascaded': PingsCascaded,
        'OffersExpired': OffersExpired,
        'WitnessTenants': WitnessTenants,
        'WitnessOffersMade': WitnessOffersMade,
        'WitnessOffersExpired': WitnessOffersExpired,
        'WitnessErrors': JsonConverters.toJson(WitnessErrors,'List<String>',context!),
        'DiningReminders': DiningReminders,
        'ThreadsScheduled': ThreadsScheduled,
        'ThreadsClosed': ThreadsClosed,
        'RoleChanges': RoleChanges,
        'RoleReleases': RoleReleases,
        'OfferPushes': OfferPushes,
        'CourierTenants': CourierTenants,
        'CourierOffers': CourierOffers,
        'CourierHeld': CourierHeld,
        'CourierLapsed': CourierLapsed,
        'CourierBooked': CourierBooked,
        'CourierErrors': JsonConverters.toJson(CourierErrors,'List<String>',context!),
        'WorkPhotosPurged': WorkPhotosPurged,
        'SmsMessagesPurged': SmsMessagesPurged,
        'SecretsRewritten': SecretsRewritten,
        'Results': JsonConverters.toJson(Results,'List<DispatchHeartbeatTenantResult>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "DispatchHeartbeatResponse";
    TypeContext? context = _ctx;
}

class DispatchHeartbeatRequest implements IConvertible
{
    String? TenantId;

    DispatchHeartbeatRequest({this.TenantId});
    DispatchHeartbeatRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TenantId = json['TenantId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TenantId': TenantId
    };

    getTypeName() => "DispatchHeartbeatRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'DispatchHeartbeatTenantResult': TypeInfo(TypeOf.Class, create:() => DispatchHeartbeatTenantResult()),
    'DispatchHeartbeatResponse': TypeInfo(TypeOf.Class, create:() => DispatchHeartbeatResponse()),
    'List<DispatchHeartbeatTenantResult>': TypeInfo(TypeOf.Class, create:() => <DispatchHeartbeatTenantResult>[]),
    'DispatchHeartbeatRequest': TypeInfo(TypeOf.Class, create:() => DispatchHeartbeatRequest()),
});

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