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
StigBalanceRequest Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberquerystringNo
StigBalanceResult Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberformstringNo
KnownformboolNo
ExcludedformboolNo
BalanceformintNo
HeldStigformintNo
AvailableformintNo
LifetimeEarnedformintNo
UpdatedUtcformDateTime?No
StatusCodeformintNo
MessageformstringNo

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/balance 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","statusCode":0,"message":"String"}