TicketUserServices

<back to all web services

JobHeartbeatReportRequest

The following routes are available for this service:
POST/JobHeartbeat
JobHeartbeatReportRequest Parameters:
NameParameterData TypeRequiredDescription
JobNamebodystringNo
PhasebodystringNo
ExpectedIntervalMinutesbodyint?No
DescriptionbodystringNo
ItemsProcessedbodylong?No
ResultJsonbodystringNo
JobHeartbeatResult Parameters:
NameParameterData TypeRequiredDescription
ItemformJobHeartbeatNo
StatusCodeformintNo
MessageformstringNo
JobHeartbeat Parameters:
NameParameterData TypeRequiredDescription
JobNameformstringNo
DescriptionformstringNo
ExpectedIntervalMinutesformintNo
LastRunAtformDateTime?No
LastOkAtformDateTime?No
LastResultJsonformstringNo
ItemsProcessedformlong?No
ConsecutiveFailuresformintNo
EnabledformboolNo
UpdatedAtformDateTimeNo

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.

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

<JobHeartbeatReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Description>String</Description>
  <ExpectedIntervalMinutes>0</ExpectedIntervalMinutes>
  <ItemsProcessed>0</ItemsProcessed>
  <JobName>String</JobName>
  <Phase>String</Phase>
  <ResultJson>String</ResultJson>
</JobHeartbeatReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobHeartbeatResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:ConsecutiveFailures>0</d2p1:ConsecutiveFailures>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Enabled>false</d2p1:Enabled>
    <d2p1:ExpectedIntervalMinutes>0</d2p1:ExpectedIntervalMinutes>
    <d2p1:ItemsProcessed>0</d2p1:ItemsProcessed>
    <d2p1:JobName>String</d2p1:JobName>
    <d2p1:LastOkAt>0001-01-01T00:00:00</d2p1:LastOkAt>
    <d2p1:LastResultJson>String</d2p1:LastResultJson>
    <d2p1:LastRunAt>0001-01-01T00:00:00</d2p1:LastRunAt>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
  </Item>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</JobHeartbeatResult>