| POST,OPTIONS | /v1/dispatch/heartbeat |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHeartbeatTenantResult:
tenant_id: Optional[str] = None
tickets: int = 0
releases: int = 0
pings_cascaded: int = 0
offers_expired: int = 0
error: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHeartbeatResponse:
tenants: int = 0
tickets: int = 0
releases: int = 0
pings_cascaded: int = 0
offers_expired: int = 0
witness_tenants: int = 0
witness_offers_made: int = 0
witness_offers_expired: int = 0
witness_errors: List[str] = field(default_factory=list)
dining_reminders: int = 0
threads_scheduled: int = 0
threads_closed: int = 0
role_changes: int = 0
role_releases: int = 0
offer_pushes: int = 0
courier_tenants: int = 0
courier_offers: int = 0
courier_held: int = 0
courier_lapsed: int = 0
courier_booked: int = 0
courier_errors: List[str] = field(default_factory=list)
work_photos_purged: int = 0
sms_messages_purged: int = 0
secrets_rewritten: int = 0
results: List[DispatchHeartbeatTenantResult] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHeartbeatRequest:
tenant_id: Optional[str] = None
Python DispatchHeartbeatRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"TenantId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Tenants":0,"Tickets":0,"Releases":0,"PingsCascaded":0,"OffersExpired":0,"WitnessTenants":0,"WitnessOffersMade":0,"WitnessOffersExpired":0,"WitnessErrors":["String"],"DiningReminders":0,"ThreadsScheduled":0,"ThreadsClosed":0,"RoleChanges":0,"RoleReleases":0,"OfferPushes":0,"CourierTenants":0,"CourierOffers":0,"CourierHeld":0,"CourierLapsed":0,"CourierBooked":0,"CourierErrors":["String"],"WorkPhotosPurged":0,"SmsMessagesPurged":0,"SecretsRewritten":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"}}}