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