TicketUserServices

StigSummaryRequest

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

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


export class StigStreakView
{
    public currentWeeks?: number;
    public longestWeeks?: number;
    public totalScanWeeks?: number;
    public totalScans?: number;
    public currentWeekKey?: string;
    public lastScanWeekKey?: string;
    public lastScanUtc?: string;
    public currentStreakStartUtc?: string;
    public scannedThisWeek?: boolean;
    public atRisk?: boolean;

    public constructor(init?: Partial<StigStreakView>) { (Object as any).assign(this, init); }
}

export class StigLadderView
{
    public rungs?: number[];
    public rungsReached?: number;
    public nextRung?: number;
    public stigToNextRung?: number;
    public progressBasisPoints?: number;

    public constructor(init?: Partial<StigLadderView>) { (Object as any).assign(this, init); }
}

export class StigSummaryResult
{
    public fullPhoneNumber?: string;
    public known?: boolean;
    public excluded?: boolean;
    public balance?: number;
    public heldStig?: number;
    public available?: number;
    public lifetimeEarned?: number;
    public updatedUtc?: string;
    public streak?: StigStreakView;
    public ladder?: StigLadderView;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<StigSummaryResult>) { (Object as any).assign(this, init); }
}

export class StigSummaryRequest
{
    public fullPhoneNumber?: string;

    public constructor(init?: Partial<StigSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>