| POST,OPTIONS | /v1/dispatch/heartbeat |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | body | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Tenants | form | int | No | |
| Tickets | form | int | No | |
| Releases | form | int | No | |
| PingsCascaded | form | int | No | |
| OffersExpired | form | int | No | |
| WitnessTenants | form | int | No | |
| WitnessOffersMade | form | int | No | |
| WitnessOffersExpired | form | int | No | |
| WitnessErrors | form | List<string> | No | |
| DiningReminders | form | int | No | |
| ThreadsScheduled | form | int | No | |
| ThreadsClosed | form | int | No | |
| RoleChanges | form | int | No | |
| RoleReleases | form | int | No | |
| OfferPushes | form | int | No | |
| CourierTenants | form | int | No | |
| CourierOffers | form | int | No | |
| CourierHeld | form | int | No | |
| CourierLapsed | form | int | No | |
| CourierBooked | form | int | No | |
| CourierErrors | form | List<string> | No | |
| WorkPhotosPurged | form | int | No | |
| SmsMessagesPurged | form | int | No | |
| SecretsRewritten | form | int | No | |
| Results | form | List<DispatchHeartbeatTenantResult> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | No | |
| Tickets | form | int | No | |
| Releases | form | int | No | |
| PingsCascaded | form | int | No | |
| OffersExpired | form | int | No | |
| Error | form | string | No |
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"}}}