Follow

API Method - Buyer Type List

This method will list the web buyer types available on the corp 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 organization ID
Return Values
A list of buyer type data structures with the following fields
BuyerTypeID
 
int
The buyer type ID
OrgID
 
int
The corp organization ID
Name
 
string
The name of the buyer type
RestrictionLevel
 
int
The restriction level of the buyer type (0 – Unrestricted buyer type, 1-3 – Restricted buyer types)
CustomerRequired
 
bool
An indicator that a customer is required on an order
GroupSales
 
bool
An indicator that this is a group sales buyer type
MembershipRequired
 
bool
An indicator that a member is required to acces the buyer type
SeasonRequired
 
bool
An indicator that a season pass is required to access the buyer type
DisplaySequence
 
int
The display sequence for sorting
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/BuyerTypeList?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}
Example JSON Response
[{
	"BuyerTypeID":2147483647,
	"OrgID":2147483647,
	"Name":"String content",
	"RestrictionLevel":2147483647,
	"CustomerRequired":true,
	"GroupSales":true,
	"MembershipRequired":true,
	"DisplaySequence":2147483647,
	"SeasonRequired":true
}]
Example XML Response
<ArrayOfBuyerType xmlns="http://www.agiletix.com/api">
  <BuyerType>
    <BuyerTypeID>2147483647</BuyerTypeID>
    <OrgID>2147483647</OrgID>
    <Name>String content</Name>
    <RestrictionLevel>2147483647</RestrictionLevel>
    <CustomerRequired>true</CustomerRequired>
    <GroupSales>true</GroupSales>
    <MembershipRequired>true</MembershipRequired>
    <DisplaySequence>2147483647</DisplaySequence>
    <SeasonRequired>true</SeasonRequired>
  </BuyerType>
  <BuyerType>
    <BuyerTypeID>2147483647</BuyerTypeID>
    <OrgID>2147483647</OrgID>
    <Name>String content</Name>
    <RestrictionLevel>2147483647</RestrictionLevel>
    <CustomerRequired>true</CustomerRequired>
    <GroupSales>true</GroupSales>
    <MembershipRequired>true</MembershipRequired>
    <DisplaySequence>2147483647</DisplaySequence>
    <SeasonRequired>true</SeasonRequired>
  </BuyerType>
</ArrayOfBuyerType>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments