TicketUserServices

<back to all web services

JobHeartbeatListRequest

The following routes are available for this service:
GET/JobHeartbeat
JobHeartbeatListRequest Parameters:
NameParameterData TypeRequiredDescription
OverdueOnlyqueryboolNo
JobHeartbeatListResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<JobHeartbeatStatus>No
OverdueCountformintNo
StatusCodeformintNo
MessageformstringNo
JobHeartbeatStatus Parameters:
NameParameterData TypeRequiredDescription
JobNameformstringNo
DescriptionformstringNo
EnabledformboolNo
LastOkAtformDateTime?No
MinutesSinceOkformint?No
ExpectedIntervalMinutesformintNo
OverdueformboolNo
ItemsProcessedformlong?No
ConsecutiveFailuresformintNo
SucceedingButIdleformboolNo

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>