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 .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"}