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;
    List<DispatchHeartbeatTenantResult>? Results = [];
    ResponseStatus? ResponseStatus;

    DispatchHeartbeatResponse({this.Tenants,this.Tickets,this.Releases,this.PingsCascaded,this.OffersExpired,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'];
        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,
        '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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TenantId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Tenants: 0,
	Tickets: 0,
	Releases: 0,
	PingsCascaded: 0,
	OffersExpired: 0,
	Results: 
	[
		{
			TenantId: 00000000000000000000000000000000,
			Tickets: 0,
			Releases: 0,
			PingsCascaded: 0,
			OffersExpired: 0,
			Error: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}