TicketUserServices

StigSummaryRequest

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

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

**StigSummaryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
FullPhoneNumber	query	string	No

**StigSummaryResult** Parameters:
Name	Parameter	Data Type	Required
FullPhoneNumber	form	string	No
Known	form	bool	No
Excluded	form	bool	No
Balance	form	int	No
HeldStig	form	int	No
Available	form	int	No
LifetimeEarned	form	int	No
UpdatedUtc	form	DateTime?	No
Streak	form	StigStreakView	No
Ladder	form	StigLadderView	No
StatusCode	form	int	No
Message	form	string	No

**StigStreakView** Parameters:
Name	Parameter	Data Type	Required
CurrentWeeks	form	int	No
LongestWeeks	form	int	No
TotalScanWeeks	form	int	No
TotalScans	form	int	No
CurrentWeekKey	form	string	No
LastScanWeekKey	form	string	No
LastScanUtc	form	DateTime?	No
CurrentStreakStartUtc	form	DateTime?	No
ScannedThisWeek	form	bool	No
AtRisk	form	bool	No

**StigLadderView** Parameters:
Name	Parameter	Data Type	Required
Rungs	form	int[]	No
RungsReached	form	int	No
NextRung	form	int?	No
StigToNextRung	form	int?	No
ProgressBasisPoints	form	int	No

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>