TicketUserServices

<back to all web services

JobHeartbeatConfigureRequest

The following routes are available for this service:
PUT/JobHeartbeat/{JobName}
import Foundation
import ServiceStack

public class JobHeartbeatConfigureRequest : Codable
{
    public var jobName:String?
    public var expectedIntervalMinutes:Int?
    public var Description:String?
    public var enabled:Bool?

    required public init(){}
}

public class JobHeartbeatResult : Codable
{
    public var item:JobHeartbeat?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class JobHeartbeat : Codable
{
    // @StringLength(100)
    public var jobName:String?

    // @StringLength(400)
    public var Description:String?

    public var expectedIntervalMinutes:Int?
    public var lastRunAt:Date?
    public var lastOkAt:Date?
    // @StringLength(Int32.max)
    public var lastResultJson:String?

    public var itemsProcessed:Int?
    public var consecutiveFailures:Int?
    public var enabled:Bool?
    public var updatedAt:Date?

    required public init(){}
}


Swift 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
}