Follow

API Method - Member Restriction List

This method will list the event ticket restrictions/benefits for a member. The optional transaction ID is used to determine if any tickets are currently in process that should affect the restriction quantities.
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
memberID
 
long
The member ID
eventID
 
long
The event ID
transactionID
 
long
 
optional
The transaction ID
Return Values
A list of membership restriction data structures with the following fields
MaxPerItem
 
int
The maximum quantity per item if tied to more than one event (If this value is -1 it is not being used)
MaxOverall
 
int
The maximum quantity across all events (If this value is -1 it is not being used)
StartDate
 
datetime
The start date for the restriction
EndDate
 
datetime
The end date for the restriction
OrgID
 
int
The corp organization ID
EventID
 
long
The event ID for the specific event restriction (If the ID is -1 then it is not specific to an event)
SalesLineTypeID
 
int
The sales line type ID
SalesLineTypeName
 
string
The name of the sales line type
TierName
 
string
The name of the tier being restricted (If blank then all tiers must follow this restriction)
TicketType
 
string
The name of the ticket type being restricted (If blank then all ticket types must follow this restriction)
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
Example Request
https://prod1.agileticketing.net/api/sales.svc/xml/MemberRestrictionList?appkey={APPKEY}&usekey={USERKEY}&corporgid={CORPORGID}&memberid={MEMBERID}&eventid={EVENTID}&transactionid={TRANSACTIONID}
Example JSON Response
[{
	"MaxPerItem":2147483647,
	"MaxOverall":2147483647,
	"StartDate":"\/Date(928167600000-0500)\/",
	"EndDate":"\/Date(928167600000-0500)\/",
	"OrgID":2147483647,
	"EventID":9223372036854775807,
	"SalesLineTypeID":2147483647,
	"SalesLineTypeName":"String content",
	"TierName":"String content",
	"TicketType":"String content"
}]
Example XML Response
<ArrayOfMemberRestriction xmlns="http://www.agiletix.com/api">
  <MemberRestriction>
    <MaxPerItem>2147483647</MaxPerItem>
    <MaxOverall>2147483647</MaxOverall>
    <StartDate>1999-05-31T11:20:00</StartDate>
    <EndDate>1999-05-31T11:20:00</EndDate>
    <OrgID>2147483647</OrgID>
    <EventID>9223372036854775807</EventID>
    <SalesLineTypeID>2147483647</SalesLineTypeID>
    <SalesLineTypeName>String content</SalesLineTypeName>
    <TierName>String content</TierName>
    <TicketType>String content</TicketType>
  </MemberRestriction>
  <MemberRestriction>
    <MaxPerItem>2147483647</MaxPerItem>
    <MaxOverall>2147483647</MaxOverall>
    <StartDate>1999-05-31T11:20:00</StartDate>
    <EndDate>1999-05-31T11:20:00</EndDate>
    <OrgID>2147483647</OrgID>
    <EventID>9223372036854775807</EventID>
    <SalesLineTypeID>2147483647</SalesLineTypeID>
    <SalesLineTypeName>String content</SalesLineTypeName>
    <TierName>String content</TierName>
    <TicketType>String content</TicketType>
  </MemberRestriction>
</ArrayOfMemberRestriction>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments