TicketUserServices

<back to all web services

StigHistoryRequest

Requires Authentication
Requires the role:AdminRequires the permission:ReadData
The following routes are available for this service:
GET/stig/history
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 LocalizedMessage:
    is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
    en: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigHistoryEntry:
    id: Optional[int] = None
    kind: Optional[str] = None
    label: Optional[LocalizedMessage] = None
    amount: Optional[int] = None
    affects_balance: Optional[bool] = None
    event_id: Optional[int] = None
    event_name: Optional[str] = None
    event_time_utc: Optional[datetime.datetime] = None
    owner_id: Optional[int] = None
    owner_name: Optional[str] = None
    ticket_id: Optional[int] = None
    order_reference: Optional[str] = None
    source_amount_minor: Optional[int] = None
    multiplier_basis_points: Optional[int] = None
    campaign_code: Optional[str] = None
    status: Optional[str] = None
    created_utc: Optional[datetime.datetime] = None
    note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigHistoryResult:
    full_phone_number: Optional[str] = None
    known: Optional[bool] = None
    items: Optional[List[StigHistoryEntry]] = None
    total_count: Optional[int] = None
    skip: Optional[int] = None
    take: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StigHistoryRequest:
    full_phone_number: Optional[str] = None
    skip: Optional[int] = None
    take: Optional[int] = None
    include_holds: Optional[bool] = None

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

<StigHistoryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <FullPhoneNumber>String</FullPhoneNumber>
  <Items>
    <StigHistoryEntry>
      <AffectsBalance>false</AffectsBalance>
      <Amount>0</Amount>
      <CampaignCode>String</CampaignCode>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventTimeUtc>0001-01-01T00:00:00</EventTimeUtc>
      <Id>0</Id>
      <Kind>String</Kind>
      <Label>
        <En>String</En>
        <Is>String</Is>
      </Label>
      <MultiplierBasisPoints>0</MultiplierBasisPoints>
      <Note>String</Note>
      <OrderReference>String</OrderReference>
      <OwnerId>0</OwnerId>
      <OwnerName>String</OwnerName>
      <SourceAmountMinor>0</SourceAmountMinor>
      <Status>String</Status>
      <TicketId>0</TicketId>
    </StigHistoryEntry>
  </Items>
  <Known>false</Known>
  <Message>String</Message>
  <Skip>0</Skip>
  <StatusCode>0</StatusCode>
  <Take>0</Take>
  <TotalCount>0</TotalCount>
</StigHistoryResult>