TicketUserServices

StigSummaryRequest

**Requires Authentication**
Requires the role:	Admin	Requires the permission:	ReadData

The following routes are available for this service:
GET	/stig/summary

import Foundation
import ServiceStack

public class StigSummaryRequest : Codable
{
    public var fullPhoneNumber:String?

    required public init(){}
}

public class StigSummaryResult : Codable
{
    public var fullPhoneNumber:String?
    public var known:Bool?
    public var excluded:Bool?
    public var balance:Int?
    public var heldStig:Int?
    public var available:Int?
    public var lifetimeEarned:Int?
    public var updatedUtc:Date?
    public var streak:StigStreakView?
    public var ladder:StigLadderView?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class StigStreakView : Codable
{
    public var currentWeeks:Int?
    public var longestWeeks:Int?
    public var totalScanWeeks:Int?
    public var totalScans:Int?
    public var currentWeekKey:String?
    public var lastScanWeekKey:String?
    public var lastScanUtc:Date?
    public var currentStreakStartUtc:Date?
    public var scannedThisWeek:Bool?
    public var atRisk:Bool?

    required public init(){}
}

public class StigLadderView : Codable
{
    public var rungs:[Int] = []
    public var rungsReached:Int?
    public var nextRung:Int?
    public var stigToNextRung:Int?
    public var progressBasisPoints:Int?

    required public init(){}
}

Swift StigSummaryRequest 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.

GET /stig/summary HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	fullPhoneNumber: String,
	known: False,
	excluded: False,
	balance: 0,
	heldStig: 0,
	available: 0,
	lifetimeEarned: 0,
	updatedUtc: 0001-01-01,
	streak: 
	{
		currentWeeks: 0,
		longestWeeks: 0,
		totalScanWeeks: 0,
		totalScans: 0,
		currentWeekKey: String,
		lastScanWeekKey: String,
		lastScanUtc: 0001-01-01,
		currentStreakStartUtc: 0001-01-01,
		scannedThisWeek: False,
		atRisk: False
	},
	ladder: 
	{
		rungs: 
		[
			0
		],
		rungsReached: 0,
		nextRung: 0,
		stigToNextRung: 0,
		progressBasisPoints: 0
	},
	statusCode: 0,
	message: String
}