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
StigSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberquerystringNo
StigSummaryResult Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberformstringNo
KnownformboolNo
ExcludedformboolNo
BalanceformintNo
HeldStigformintNo
AvailableformintNo
LifetimeEarnedformintNo
UpdatedUtcformDateTime?No
StreakformStigStreakViewNo
LadderformStigLadderViewNo
StatusCodeformintNo
MessageformstringNo
StigStreakView Parameters:
NameParameterData TypeRequiredDescription
CurrentWeeksformintNo
LongestWeeksformintNo
TotalScanWeeksformintNo
TotalScansformintNo
CurrentWeekKeyformstringNo
LastScanWeekKeyformstringNo
LastScanUtcformDateTime?No
CurrentStreakStartUtcformDateTime?No
ScannedThisWeekformboolNo
AtRiskformboolNo
StigLadderView Parameters:
NameParameterData TypeRequiredDescription
Rungsformint[]No
RungsReachedformintNo
NextRungformint?No
StigToNextRungformint?No
ProgressBasisPointsformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"fullPhoneNumber":"String","known":false,"excluded":false,"balance":0,"heldStig":0,"available":0,"lifetimeEarned":0,"updatedUtc":"0001-01-01T00:00:00.0000000","streak":{"currentWeeks":0,"longestWeeks":0,"totalScanWeeks":0,"totalScans":0,"currentWeekKey":"String","lastScanWeekKey":"String","lastScanUtc":"0001-01-01T00:00:00.0000000","currentStreakStartUtc":"0001-01-01T00:00:00.0000000","scannedThisWeek":false,"atRisk":false},"ladder":{"rungs":[0],"rungsReached":0,"nextRung":0,"stigToNextRung":0,"progressBasisPoints":0},"statusCode":0,"message":"String"}