Configuration of the various Badges people will ultimately purchase.
You'll need the registration
ConventionPrivilege to edit these.
Badge Types are accessed via /api/badgetype
.
See "Object Properties" in Introduction for basic shared properties.
Complete details in BadgeTypeProperties. It also has these extra read-only properties:
The number of badges still available for this badge type.
Fields sold_count
and max_available_count
are deprecated and replaced in use by taken_count
and max_quantity
,
respectively.
See "Related Objects" in Introduction for how to use them.
BadgeTypeCategory is a relationship that allows the grouping of like badge types together.
The Convention this badgetype belongs to.
See "Relationships" in Introduction for how to use them.
The list of Badges that have been created for this badge type.
BadgeTypeConDays manage the relationship between badge types and ConventionDays.
BadgeTypeDiscounts manage the relationship between badge types and Discounts.
BadgeTypeEventTypes restrict a badgetype's complimentary Tickets, if any, to Events of the specified EventTypes.
BadgeTypeProducts manage the relationship between badge types and complimentary Products.
If using the exhibitor management system, then BoothTypes may give away a certain quantity of free badges and they'll select which badge type to give away.
The Products complimentary with a badge of this badge type.
The ConventionDays this badge is allowed to enter the convention, and buy Tickets for if ticketing is enabled.
The Discounts usable when buying a Badge based upon this badge type. (Associated via "badgetypediscounts".)
EventGroupBadgeTypes manage the relationship between badge types and EventGroups.
If ticketing is enabled and event groups are enabled then this is the list of EventGroups that this badge type has access to buy events for.
The EventTypes associated to the badgetype via its BadgeTypeEventTypes; see above.
If the convention is set to require Volunteers to have a Badge for the same day they want to volunteer, ShiftBadgeTypes manage the relationship between Shifts and their supporting badge types.
The list of Sponsorships offering complimentary badges of this badge type.
See "Includes" in Introduction for how to use them.
Sets two flag values for the badgetype; and,
sets the flags under includes_comp_tickets
below,
for four values total.
Whether there are any Events available for complimentary Tickets offered by the badgetype. Simple comp means events available generally. Group comp means events available via EventGroups.
Sets a single flag for the badgetype.
Whether there are unclaimed available complimentary Products with the badgetype.
A list of unclaimed Products complimentary with the badgetype.
Sets two flag values for the badgetype.
Flags if the BadgeType includes any complimentary Tickets.
1
means yes,
0
means no.
Simple comp tickets are ones for events available generally.
Group comp tickets are ones for events available via EventGroups.
The services used to fetch and manipulate badgetypes.
This will search across all conventions. To search on a single convention see "Relationships" in Convention.
GET /api/badgetype
Searches a partial name.
Returns:
{ "paging" : {...}, "items" : [ { "id" : "xxx", "name" : "Weekend Badge", ... }, ... ] }
POST /api/badgetype
Returns the same as a normal read.
GET /api/badgetype/xxx
Returns:
{ "id" : "xxx", "name" : "Weekend Badge", ... }
PUT /api/badgetype/xxx
Returns the same as a normal read.
DELETE /api/badgetype/xxx
Returns:
{ "success" : 1 }
Gets all the badge type's complimentary non-grouped Events which have seats available.
GET /api/badgetype/xxx/comp-events/available
Returns the list of Events.
Gets all the badge type's complimentary Events, associated with EventGroups, which have seats available.
GET /api/badgetype/xxx/comp-group-events/available
Returns the list of Events.
Gets the badge type's complimentary products, if any, but limited to those still available. See "complimentary_products".
GET /api/badgetype/xxx/complimentary_products/available
Returns the same as a normal read from "complimentary_products", except only those available.
Gets any Discounts still available to the badge type.
GET /api/badgetype/xxx/available-discounts
Returns the list of Discounts.
Gets any EventGroups not yet associated with the badgetype via EventGroupBadgeTypes.
Returns the list of EventGroups.
Gets any EventTypes not yet associated with the badgetype via BadgeTypeEventTypes.
Returns the list of EventTypes.