TicketUserServices

<back to all web services

JobHeartbeatReportRequest

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

namespace TicketUserServices.ServiceModel
{
    public partial class JobHeartbeatReportRequest
    {
        public virtual string JobName { get; set; }
        public virtual string Phase { get; set; }
        public virtual int? ExpectedIntervalMinutes { get; set; }
        public virtual string Description { get; set; }
        public virtual long? ItemsProcessed { get; set; }
        public virtual string ResultJson { get; set; }
    }

    public partial class JobHeartbeatResult
    {
        public virtual JobHeartbeat Item { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

}

namespace TicketUserServices.ServiceModel.Types
{
    public partial class JobHeartbeat
    {
        [StringLength(100)]
        public virtual string JobName { get; set; }

        [StringLength(400)]
        public virtual string Description { get; set; }

        public virtual int ExpectedIntervalMinutes { get; set; }
        public virtual DateTime? LastRunAt { get; set; }
        public virtual DateTime? LastOkAt { get; set; }
        [StringLength(int.MaxValue)]
        public virtual string LastResultJson { get; set; }

        public virtual long? ItemsProcessed { get; set; }
        public virtual int ConsecutiveFailures { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual DateTime UpdatedAt { get; set; }
    }

}

C# JobHeartbeatReportRequest 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.

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

{
	jobName: String,
	phase: String,
	expectedIntervalMinutes: 0,
	description: String,
	itemsProcessed: 0,
	resultJson: String
}
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
}