This method will get the current sales status for an event.
Parameters
appKey
string
A key identifying the application making the call
userKey
string
A key identifying the user making the call
corpOrgID
int
The corp organization ID
eventID
int
The event ID
buyerTypeID
int
The buyer type ID
Return Values
A sales status data structure with the following fields
OnSale
bool
The current onsales status for the event
StartSales
datetime
The date/time when sales start
EndSales
datetime
The date/time when sales end
EnforceQuantities
bool
An idicator that quanties are enforced for the event and buyer type
MinQtyPerOrder
int
The minimum purchase quantity
MaxQtyPerOrder
int
The maximum purchase quantity
DisplayMessage
bool
An indicator that the message text should be shown
MessageText
string
The custom message text
AvailabilityText
string
The availability text to show when an event is sold out
Errors
ApplicationKeyMissing
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
1001
Required user credentials are missing or invalid
SecurityInsufficient
1002
User security does not permit access to the requested function
RequiredParameter
1028
Required parameter is missing
RequestedEventNotFound
1007
Requested event not found
Example Request
https://prod1.agileticketing.net/api/sales.svc/xml/EventSalesStatus?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&eventid={EVENTID}&buyertypeid={BUYERTYPEID}
Example JSON Response
{
"OnSale":true,
"StartSales":"\/Date(928167600000-0500)\/",
"EndSales":"\/Date(928167600000-0500)\/",
"EnforceQuantities":true,
"MinQtyPerOrder":2147483647,
"MaxQtyPerOrder":2147483647,
"DisplayMessage":true,
"MessageText":"String content",
"AvailabilityText":"String content"
}
Example XML Response
<SalesStatus xmlns="http://www.agiletix.com/api"> <OnSale>true</OnSale> <StartSales>1999-05-31T11:20:00</StartSales> <EndSales>1999-05-31T11:20:00</EndSales> <EnforceQuantities>true</EnforceQuantities> <MinQtyPerOrder>2147483647</MinQtyPerOrder> <MaxQtyPerOrder>2147483647</MaxQtyPerOrder> <DisplayMessage>true</DisplayMessage> <MessageText>String content</MessageText> <AvailabilityText>String content</AvailabilityText> </SalesStatus>
Comments