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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}