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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class StigLadderView
    {
        public StigLadderView()
        {
            Rungs = new int[]{};
        }

        public virtual int[] Rungs { get; set; }
        public virtual int RungsReached { get; set; }
        public virtual int? NextRung { get; set; }
        public virtual int? StigToNextRung { get; set; }
        public virtual int ProgressBasisPoints { get; set; }
    }

    public partial class StigStreakView
    {
        public virtual int CurrentWeeks { get; set; }
        public virtual int LongestWeeks { get; set; }
        public virtual int TotalScanWeeks { get; set; }
        public virtual int TotalScans { get; set; }
        public virtual string CurrentWeekKey { get; set; }
        public virtual string LastScanWeekKey { get; set; }
        public virtual DateTime? LastScanUtc { get; set; }
        public virtual DateTime? CurrentStreakStartUtc { get; set; }
        public virtual bool ScannedThisWeek { get; set; }
        public virtual bool AtRisk { get; set; }
    }

    public partial class StigSummaryRequest
    {
        public virtual string FullPhoneNumber { get; set; }
    }

    public partial class StigSummaryResult
    {
        public virtual string FullPhoneNumber { get; set; }
        public virtual bool Known { get; set; }
        public virtual bool Excluded { get; set; }
        public virtual int Balance { get; set; }
        public virtual int HeldStig { get; set; }
        public virtual int Available { get; set; }
        public virtual int LifetimeEarned { get; set; }
        public virtual DateTime? UpdatedUtc { get; set; }
        public virtual StigStreakView Streak { get; set; }
        public virtual StigLadderView Ladder { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

}

C# 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>