TicketUserServices

StigSummaryRequest

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

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigStreakView:
    current_weeks: Optional[int] = None
    longest_weeks: Optional[int] = None
    total_scan_weeks: Optional[int] = None
    total_scans: Optional[int] = None
    current_week_key: Optional[str] = None
    last_scan_week_key: Optional[str] = None
    last_scan_utc: Optional[datetime.datetime] = None
    current_streak_start_utc: Optional[datetime.datetime] = None
    scanned_this_week: Optional[bool] = None
    at_risk: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigLadderView:
    rungs: Optional[List[int]] = None
    rungs_reached: Optional[int] = None
    next_rung: Optional[int] = None
    stig_to_next_rung: Optional[int] = None
    progress_basis_points: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigSummaryResult:
    full_phone_number: Optional[str] = None
    known: Optional[bool] = None
    excluded: Optional[bool] = None
    balance: Optional[int] = None
    held_stig: Optional[int] = None
    available: Optional[int] = None
    lifetime_earned: Optional[int] = None
    updated_utc: Optional[datetime.datetime] = None
    streak: Optional[StigStreakView] = None
    ladder: Optional[StigLadderView] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigSummaryRequest:
    full_phone_number: Optional[str] = None

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