Follow

API Method - List Messages

This method will list Scan messages defined by the organization
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 org to list messages for
Return Values
A list of gate control message data structures containing the following fields
OrgID
 
int
OrgID
Code
 
int
Status
ShortMessage
 
string
ShortMessage
Message
 
string
Message
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
Example Request
https://prod1.agileticketing.net/GateControl.svc/xml/ListMessages?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}
Example XML Response
<ArrayOfGateControlMessage xmlns="http://www.agiletix.com/api">
  <GateControlMessage>
    <OrgID>2147483647</OrgID>
    <Code>2147483647</Code>
    <ShortMessage>String content</ShortMessage>
    <Message>String content</Message>
  </GateControlMessage>
  <GateControlMessage>
    <OrgID>2147483647</OrgID>
    <Code>2147483647</Code>
    <ShortMessage>String content</ShortMessage>
    <Message>String content</Message>
  </GateControlMessage>
</ArrayOfGateControlMessage>
Example JSON Response
[{
	"OrgID":2147483647,
	"Code":2147483647,
	"ShortMessage":"String content",
	"Message":"String content"
}]
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments