TicketUserServices

StigSummaryRequest

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

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class StigLadderView
            Public Sub New()
                Rungs = New Integer(){}
            End Sub

            Public Overridable Property Rungs As Integer()
            Public Overridable Property RungsReached As Integer
            Public Overridable Property NextRung As Nullable(Of Integer)
            Public Overridable Property StigToNextRung As Nullable(Of Integer)
            Public Overridable Property ProgressBasisPoints As Integer
        End Class

        Public Partial Class StigStreakView
            Public Overridable Property CurrentWeeks As Integer
            Public Overridable Property LongestWeeks As Integer
            Public Overridable Property TotalScanWeeks As Integer
            Public Overridable Property TotalScans As Integer
            Public Overridable Property CurrentWeekKey As String
            Public Overridable Property LastScanWeekKey As String
            Public Overridable Property LastScanUtc As Nullable(Of Date)
            Public Overridable Property CurrentStreakStartUtc As Nullable(Of Date)
            Public Overridable Property ScannedThisWeek As Boolean
            Public Overridable Property AtRisk As Boolean
        End Class

        Public Partial Class StigSummaryRequest
            Public Overridable Property FullPhoneNumber As String
        End Class

        Public Partial Class StigSummaryResult
            Public Overridable Property FullPhoneNumber As String
            Public Overridable Property Known As Boolean
            Public Overridable Property Excluded As Boolean
            Public Overridable Property Balance As Integer
            Public Overridable Property HeldStig As Integer
            Public Overridable Property Available As Integer
            Public Overridable Property LifetimeEarned As Integer
            Public Overridable Property UpdatedUtc As Nullable(Of Date)
            Public Overridable Property Streak As StigStreakView
            Public Overridable Property Ladder As StigLadderView
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET 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>