TicketUserServices

<back to all web services

JobHeartbeatConfigureRequest

The following routes are available for this service:
PUT/JobHeartbeat/{JobName}
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type JobHeartbeat() = 
        [<StringLength(100)>]
        member val JobName:String = null with get,set

        [<StringLength(400)>]
        member val Description:String = null with get,set

        member val ExpectedIntervalMinutes:Int32 = new Int32() with get,set
        member val LastRunAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastOkAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<StringLength(Int32.MaxValue)>]
        member val LastResultJson:String = null with get,set

        member val ItemsProcessed:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val ConsecutiveFailures:Int32 = new Int32() with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val UpdatedAt:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type JobHeartbeatResult() = 
        member val Item:JobHeartbeat = null with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type JobHeartbeatConfigureRequest() = 
        member val JobName:String = null with get,set
        member val ExpectedIntervalMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Description:String = null with get,set
        member val Enabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# JobHeartbeatConfigureRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /JobHeartbeat/{JobName} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jobName: String,
	expectedIntervalMinutes: 0,
	description: String,
	enabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		jobName: String,
		description: String,
		expectedIntervalMinutes: 0,
		lastRunAt: 0001-01-01,
		lastOkAt: 0001-01-01,
		lastResultJson: String,
		itemsProcessed: 0,
		consecutiveFailures: 0,
		enabled: False,
		updatedAt: 0001-01-01
	},
	statusCode: 0,
	message: String
}