Badge Type

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.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in BadgeTypeProperties. It also has these extra read-only properties:

available_quantity

The number of badges still available for this badge type.

Deprecation Note -- August 2022

Fields sold_count and max_available_count are deprecated and replaced in use by taken_count and max_quantity, respectively.

Related Objects

See "Related Objects" in Introduction for how to use them.

badgetypecategory

BadgeTypeCategory is a relationship that allows the grouping of like badge types together.

convention

The Convention this badgetype belongs to.

Relationships

See "Relationships" in Introduction for how to use them.

badges

The list of Badges that have been created for this badge type.

Queryable

badge_number

firstname

lastname

Qualifiers

badgetype_id

checked_in

verified

badgetypecondays

BadgeTypeConDays manage the relationship between badge types and ConventionDays.

badgetypediscounts

BadgeTypeDiscounts manage the relationship between badge types and Discounts.

badgetypeeventtypes

BadgeTypeEventTypes restrict a badgetype's complimentary Tickets, if any, to Events of the specified EventTypes.

badgetypeproducts

BadgeTypeProducts manage the relationship between badge types and complimentary Products.

boothtypes

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.

complimentary_products

The Products complimentary with a badge of this badge type.

days

The ConventionDays this badge is allowed to enter the convention, and buy Tickets for if ticketing is enabled.

discounts

The Discounts usable when buying a Badge based upon this badge type. (Associated via "badgetypediscounts".)

Queryable

discount.name

discount.description

Qualifiers

discount.enabled

discount.public

eventgroupbadgetypes

EventGroupBadgeTypes manage the relationship between badge types and EventGroups.

Queryable

eventgroup.name

Qualifiers

eventgroup.limit_by_badge_type

No longer used.

eventgroup.tickets_autoincluded

max_tickets_per_badge

tickets_included

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.

eventtypes

The EventTypes associated to the badgetype via its BadgeTypeEventTypes; see above.

shiftbadgetypes

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.

sponsorships

The list of Sponsorships offering complimentary badges of this badge type.

Includes

See "Includes" in Introduction for how to use them.

complimentary_event_availability

Sets two flag values for the badgetype; and, sets the flags under includes_comp_tickets below, for four values total.

has_available_comp_events

has_available_comp_group_events

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.

complimentary_product_availability

Sets a single flag for the badgetype.

has_available_complimentary_products

Whether there are unclaimed available complimentary Products with the badgetype.

complimentary_products

A list of unclaimed Products complimentary with the badgetype.

includes_comp_tickets

Sets two flag values for the badgetype.

includes_simple_comp_tickets

includes_group_comp_tickets

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.

Services

The services used to fetch and manipulate badgetypes.

Search Badge Types

Searching all badge types across conventions is no longer supported. To search on a single convention see "Relationships" in Convention.

Create Badge Type

 POST /api/badgetype

Required Params

session_id

convention_id

name

Returns the same as a normal read.

Read Badge Type

 GET /api/badgetype/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Weekend Badge",
   ...
 }

Update BadgeType

 PUT /api/badgetype/xxx

Returns the same as a normal read.

Delete BadgeType

 DELETE /api/badgetype/xxx

Returns:

 {
   "success" : 1
 }

Available Complimentary Events (non-grouped events)

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.

Available Complimentary Grouped 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.

Available Complimentary Products

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.

Available Discounts

Gets any Discounts still available to the badge type.

 GET /api/badgetype/xxx/available-discounts

Returns the list of Discounts.

Remaining Event Groups

Gets any EventGroups not yet associated with the badgetype via EventGroupBadgeTypes.

Returns the list of EventGroups.

Remaining Event Types

Gets any EventTypes not yet associated with the badgetype via BadgeTypeEventTypes.

Returns the list of EventTypes.