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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StigSummaryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Available>0</Available>
  <Balance>0</Balance>
  <Excluded>false</Excluded>
  <FullPhoneNumber>String</FullPhoneNumber>
  <HeldStig>0</HeldStig>
  <Known>false</Known>
  <Ladder>
    <NextRung>0</NextRung>
    <ProgressBasisPoints>0</ProgressBasisPoints>
    <Rungs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Rungs>
    <RungsReached>0</RungsReached>
    <StigToNextRung>0</StigToNextRung>
  </Ladder>
  <LifetimeEarned>0</LifetimeEarned>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <Streak>
    <AtRisk>false</AtRisk>
    <CurrentStreakStartUtc>0001-01-01T00:00:00</CurrentStreakStartUtc>
    <CurrentWeekKey>String</CurrentWeekKey>
    <CurrentWeeks>0</CurrentWeeks>
    <LastScanUtc>0001-01-01T00:00:00</LastScanUtc>
    <LastScanWeekKey>String</LastScanWeekKey>
    <LongestWeeks>0</LongestWeeks>
    <ScannedThisWeek>false</ScannedThisWeek>
    <TotalScanWeeks>0</TotalScanWeeks>
    <TotalScans>0</TotalScans>
  </Streak>
  <UpdatedUtc>0001-01-01T00:00:00</UpdatedUtc>
</StigSummaryResult>