Follow

API Method - Event Get Description

This method will get an event’s description based on the event ID.  The event description is not included in the other event based API methods because it can contain a large amount of HTML data.  It is recommended that the event short description be used by default when displaying event data.  The full event description should be shown when more detailed event information is needed such as when clicking a “More Event Info” link.
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
 
long
The event ID
Return Values
A string containing the event description
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/EventGetDescription?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&eventid={EVENTID}
Example JSON Response
"String content"
Example XML Response
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">String content</string>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments