TicketUserServices

<back to all web services

JobHeartbeatReportRequest

The following routes are available for this service:
POST/JobHeartbeat
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel
Imports TicketUserServices.ServiceModel.Types

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class JobHeartbeatReportRequest
            Public Overridable Property JobName As String
            Public Overridable Property Phase As String
            Public Overridable Property ExpectedIntervalMinutes As Nullable(Of Integer)
            Public Overridable Property Description As String
            Public Overridable Property ItemsProcessed As Nullable(Of Long)
            Public Overridable Property ResultJson As String
        End Class

        Public Partial Class JobHeartbeatResult
            Public Overridable Property Item As JobHeartbeat
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class
    End Namespace

    Namespace TicketUserServices.ServiceModel.Types

        Public Partial Class JobHeartbeat
            <StringLength(100)>
            Public Overridable Property JobName As String

            <StringLength(400)>
            Public Overridable Property Description As String

            Public Overridable Property ExpectedIntervalMinutes As Integer
            Public Overridable Property LastRunAt As Nullable(Of Date)
            Public Overridable Property LastOkAt As Nullable(Of Date)
            <StringLength(Integer.MaxValue)>
            Public Overridable Property LastResultJson As String

            Public Overridable Property ItemsProcessed As Nullable(Of Long)
            Public Overridable Property ConsecutiveFailures As Integer
            Public Overridable Property Enabled As Boolean
            Public Overridable Property UpdatedAt As Date
        End Class
    End Namespace
End Namespace

VB.NET JobHeartbeatReportRequest 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

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"jobName":"String","phase":"String","expectedIntervalMinutes":0,"description":"String","itemsProcessed":0,"resultJson":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"item":{"jobName":"String","description":"String","expectedIntervalMinutes":0,"lastRunAt":"0001-01-01T00:00:00.0000000","lastOkAt":"0001-01-01T00:00:00.0000000","lastResultJson":"String","itemsProcessed":0,"consecutiveFailures":0,"enabled":false,"updatedAt":"0001-01-01T00:00:00.0000000"},"statusCode":0,"message":"String"}