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
StigHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberquerystringNo
Skipqueryint?No
Takequeryint?No
IncludeHoldsqueryboolNo
StigHistoryResult Parameters:
NameParameterData TypeRequiredDescription
FullPhoneNumberformstringNo
KnownformboolNo
ItemsformList<StigHistoryEntry>No
TotalCountformintNo
SkipformintNo
TakeformintNo
StatusCodeformintNo
MessageformstringNo
StigHistoryEntry Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KindformstringNo
LabelformLocalizedMessageNo
AmountformintNo
AffectsBalanceformboolNo
EventIdformint?No
EventNameformstringNo
EventTimeUtcformDateTime?No
OwnerIdformintNo
OwnerNameformstringNo
TicketIdformint?No
OrderReferenceformstringNo
SourceAmountMinorformint?No
MultiplierBasisPointsformintNo
CampaignCodeformstringNo
StatusformstringNo
CreatedUtcformDateTimeNo
NoteformstringNo
LocalizedMessage Parameters:
NameParameterData TypeRequiredDescription
IsformstringNo
EnformstringNo

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/history 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,
	items: 
	[
		{
			id: 0,
			kind: String,
			label: 
			{
				is: String,
				en: String
			},
			amount: 0,
			affectsBalance: False,
			eventId: 0,
			eventName: String,
			eventTimeUtc: 0001-01-01,
			ownerId: 0,
			ownerName: String,
			ticketId: 0,
			orderReference: String,
			sourceAmountMinor: 0,
			multiplierBasisPoints: 0,
			campaignCode: String,
			status: String,
			createdUtc: 0001-01-01,
			note: String
		}
	],
	totalCount: 0,
	skip: 0,
	take: 0,
	statusCode: 0,
	message: String
}