| Requires the role: | Admin | Requires the permission: | ReadData |
| GET | /stig/summary |
|---|
namespace TicketUserServices.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type StigStreakView() =
member val CurrentWeeks:Int32 = new Int32() with get,set
member val LongestWeeks:Int32 = new Int32() with get,set
member val TotalScanWeeks:Int32 = new Int32() with get,set
member val TotalScans:Int32 = new Int32() with get,set
member val CurrentWeekKey:String = null with get,set
member val LastScanWeekKey:String = null with get,set
member val LastScanUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CurrentStreakStartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ScannedThisWeek:Boolean = new Boolean() with get,set
member val AtRisk:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type StigLadderView() =
member val Rungs:Int32[] = [||] with get,set
member val RungsReached:Int32 = new Int32() with get,set
member val NextRung:Nullable<Int32> = new Nullable<Int32>() with get,set
member val StigToNextRung:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ProgressBasisPoints:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type StigSummaryResult() =
member val FullPhoneNumber:String = null with get,set
member val Known:Boolean = new Boolean() with get,set
member val Excluded:Boolean = new Boolean() with get,set
member val Balance:Int32 = new Int32() with get,set
member val HeldStig:Int32 = new Int32() with get,set
member val Available:Int32 = new Int32() with get,set
member val LifetimeEarned:Int32 = new Int32() with get,set
member val UpdatedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Streak:StigStreakView = null with get,set
member val Ladder:StigLadderView = null with get,set
member val StatusCode:Int32 = new Int32() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type StigSummaryRequest() =
member val FullPhoneNumber:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}