TicketUserServices

<back to all web services

JobHeartbeatListRequest

The following routes are available for this service:
GET/JobHeartbeat
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 JobHeartbeatStatus:
    job_name: Optional[str] = None
    description: Optional[str] = None
    enabled: Optional[bool] = None
    last_ok_at: Optional[datetime.datetime] = None
    minutes_since_ok: Optional[int] = None
    expected_interval_minutes: Optional[int] = None
    overdue: Optional[bool] = None
    items_processed: Optional[int] = None
    consecutive_failures: Optional[int] = None
    succeeding_but_idle: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobHeartbeatListResult:
    items: Optional[List[JobHeartbeatStatus]] = None
    overdue_count: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobHeartbeatListRequest:
    overdue_only: Optional[bool] = None

Python JobHeartbeatListRequest 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.

GET /JobHeartbeat HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobHeartbeatListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items>
    <JobHeartbeatStatus>
      <ConsecutiveFailures>0</ConsecutiveFailures>
      <Description>String</Description>
      <Enabled>false</Enabled>
      <ExpectedIntervalMinutes>0</ExpectedIntervalMinutes>
      <ItemsProcessed>0</ItemsProcessed>
      <JobName>String</JobName>
      <LastOkAt>0001-01-01T00:00:00</LastOkAt>
      <MinutesSinceOk>0</MinutesSinceOk>
      <Overdue>false</Overdue>
      <SucceedingButIdle>false</SucceedingButIdle>
    </JobHeartbeatStatus>
  </Items>
  <Message>String</Message>
  <OverdueCount>0</OverdueCount>
  <StatusCode>0</StatusCode>
</JobHeartbeatListResult>