TicketUserServices

<back to all web services

StigBalanceRequest

Requires Authentication
Requires the role:AdminRequires the permission:ReadData
The following routes are available for this service:
GET/stig/balance
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 StigBalanceResult:
    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
    status_code: Optional[int] = None
    message: Optional[str] = None


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

Python StigBalanceRequest 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/balance HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StigBalanceResult 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>
  <LifetimeEarned>0</LifetimeEarned>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <UpdatedUtc>0001-01-01T00:00:00</UpdatedUtc>
</StigBalanceResult>