TicketUserServices

<back to all web services

StigSummaryRequest

Requires Authentication
Requires the role:AdminRequires the permission:ReadData
The following routes are available for this service:
GET/stig/summary
import java.math.*
import java.util.*
import net.servicestack.client.*


open class StigSummaryRequest
{
    var fullPhoneNumber:String? = null
}

open class StigSummaryResult
{
    var fullPhoneNumber:String? = null
    var known:Boolean? = null
    var excluded:Boolean? = null
    var balance:Int? = null
    var heldStig:Int? = null
    var available:Int? = null
    var lifetimeEarned:Int? = null
    var updatedUtc:Date? = null
    var streak:StigStreakView? = null
    var ladder:StigLadderView? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class StigStreakView
{
    var currentWeeks:Int? = null
    var longestWeeks:Int? = null
    var totalScanWeeks:Int? = null
    var totalScans:Int? = null
    var currentWeekKey:String? = null
    var lastScanWeekKey:String? = null
    var lastScanUtc:Date? = null
    var currentStreakStartUtc:Date? = null
    var scannedThisWeek:Boolean? = null
    var atRisk:Boolean? = null
}

open class StigLadderView
{
    var rungs:ArrayList<Int>? = null
    var rungsReached:Int? = null
    var nextRung:Int? = null
    var stigToNextRung:Int? = null
    var progressBasisPoints:Int? = null
}

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