Badge

Badges gain you admittance to a Convention. You'll need the registration ConventionPrivilege to edit badges. Badges are accessed via /api/badge.

Properties

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

Complete details in BadgeProperties. It also has the following read-only properties:

shortname

A unique name that can be used to easily identify this badge.

Related Objects

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

badgetype

The BadgeType that this badge gets its configuration from.

booth

If this badge was assigned to an Exhibitor for free, then it will be attached to a Booth.

convention

The Convention this badge belongs to.

conventioncart

The ConventionCart this badge sits in (if any).

conventionreceipt

The ConventionReceipt showing the transaction history of this badge (if it was created via a checkout process).

discount

The Discount used on this badge (if any).

user

The User that controls this badge.

Relationships

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

librarygamecheckouts

The list of LibraryGameCheckouts associated with this badge, if any.

playtowins

The PlayToWins associated with this badge, if any.

soldproducts

SoldProducts are ProductVariants purchased by this badge.

tickets

Queryable
ticket_number
Qualifiers
badge_id
event_id
picked_up
verified

Includes

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

longname

A very descriptive name for this badge. It pulls data from several objects, which is why it is not included by default.

Services

The services used to fetch and manipulate badges.

Search Badges

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/badge
Optional Params
query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Joe User",
          ...
        },
        ...
    ]
 }

Create Badge

Generallly you don't create badges this way, instead you do it through the ConventionCart API. This will put a badge in the system, but it will not be marked verified. It will still need to go through a checkout process or some other means of marking itself verified.

 POST /api/badge
Required Params
session_id
name
convention_id
badgetype_id

Returns the same as a normal read.

Administratively Create Badge

This will create a badge that is fully verified. You'll of course need to have the registration ConventionPrivilege to do this.

 POST /api/badge/verified
Required Params

Same as a normal badge creation.

If you specify the email field, then one of two things will happen. If the email address is already in our system, the badge will be attached to that user account. If the email address is not already in our system, then an account with that email address will be created and the user will be emailed asking them to set a password for their account.

Returns the same as a normal read.

Read Badge

 GET /api/badge/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Joe User",
   ...
 }

Update Badge

 PUT /api/badge/xxx

Returns the same as a normal read.

Delete Badge

 DELETE /api/badge/xxx
Optional params
cashdrawer_id

You need to specify this to refund if purchased with cash in the point of sale system.

Returns:

 {
   "success" : 1
 }

Check-In Badge

 PUT /api/badge/xxx/check-in

Returns the same as a normal read.

Undo Badge Check-In

 PUT /api/badge/xxx/reverse-check-in

Returns the same as a normal read.

Assign New User To Badge

 POST /api/badge/xxx/user
Required Params
user_id

Returns the same as a normal read.