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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	fullPhoneNumber: String,
	known: False,
	excluded: False,
	balance: 0,
	heldStig: 0,
	available: 0,
	lifetimeEarned: 0,
	updatedUtc: 0001-01-01,
	statusCode: 0,
	message: String
}