Convention

Conventions are accessed via /api/convention.

Properties

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

Complete details in ConventionProperties.

Related Objects

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

badgeheaderimage

A ConventionImage that will be used to generate printed Badges.

geolocation

A GeoLocation of the general area where the convention will be held.

group

A Group that is in charge of the convention.

headerimage

A ConventionImage that will be displayed at the top of all the convention's pages.

library

A Library that will be available at the convention, if any.

venue

A Venue where the convention will be held.

venuemapimage

A ConventionImage that shows the map of the convention Venue.

Relationships

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

badges

Badges created for this convention.

Queryable
name
badge_number
Qualifiers
badge_number
badgetype_id
booth_id
checked_in
verified
print_count
user_id

badgetypecategories

BadgeTypeCategorys created for this convention.

badgetypes

BadgeTypes created for this convention.

boothoptions

BoothOptions created for this convention.

booths

Booths created for this convention.

Queryable
name
Qualfiers
exhibitor_id
roomzone_id
verified

boothtypes

BoothTypes creeated for this convention.

carts

ConventionCarts created for this convention.

cashdrawers

CashDrawers created for this convention.

dayparts

DayParts created for this convention.

Qualifiers
conventionday_id
start_date

days

ConventionDays created for this convention.

discounts

Discounts created for this convention.

Queryable
name
code
Qualifiers
use_with_booths
use_with_boothoptions
enabled
public

eventgroups

EventGroups created for this convention.

Queryable
name
Qualifiers
limit_by_badge_type

events

Events created for this convention.

Queryable
name
event_number
user.real_name

Aka the event host's name.

Qualifiers
type_id
is_scheduled
is_cancelled
priority
user_id
room_id
startdaypart_id
event_number

eventsubmissions

EventSubmissions created for this convention.

Queryable
name
user.real_name

Aka the event submitter's real name.

Qualifiers
status

eventtyperooms

EventTypeRooms created for this convention.

Qualifiers
eventtype_id
room_id

eventtypes

EventTypes created for this convention.

Qualifiers
user_submittable

eventwaits

EventWaits created for this convention.

exhibitors

Exhibitors created for this convention.

Queryable
name
Qualifiers
user_id
status

hosts

A list of Users that run Events.

Queryable
name

images

ConventionImages created for this convention.

ledgerentries

LedgerEntrys created for this convention.

librarygamecheckouts

The LibraryGameCheckouts associated with this convention.

pages

Pages created for this convention.

playtowins

The PlayToWins associated with this convention.

privileges

ConventionPrivileges created for this convention.

products

Products created for this convention.

Queryable
name

productvariants

ProductVariants created for this convention.

Queryable
name
Qualifiers
product_id

prototypes

Prototypes created for this convention.

Queryable
name
synopsis
description
Qualifiers
audience
min_players
max_players
status
user_id

receipts

ConventionReceipts created for this convention.

rooms

Rooms created for this convention.

Queryable
name
Qualifiers
booths_available_count
booths_sold_count

roomzones

RoomZones created for this convention.

slots

Slots created for this convention.

Queryable
name
Qualifiers
space_id
event_id
daypart_id
room_id
conventionday_id

soldproducts

SoldProducts created for this convention.

Queryable
productvariant.name
Qualifiers
picked_up
productvariant_id
badge_id
verified

spaces

Spaces created for this convention.

Queryable
name
Qualifiers
room_id

tickets

Tickets created for this convention.

Queryable
ticket_number
Qualifiers
badge_id
event_id
picked_up
verified

updates

News Updates created for this convention.

Services

The services used to fetch and manipulate conventions.

Search Conventions

Returns conventions that have not yet ended. By default it only returns public conventions, but if you provide a session_id it will also include any conventions run by Groups you are a Member of.

 GET /api/convention
Optional Params
query

A partial convention name.

Returns:

 {
    "items" : [
        {
            "id" : "xxx",
            "name" : "Big Apple Con 2017",
            ...
        },
        ...
    ],
    "paging" : {...}
 }

Create Convention

 POST /api/convention
Required Params
session_id
name
group_id
geolocation_id

Returns the same as a normal read.

Read Convention

 GET /api/convention/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Big Apple Con 2017",
   ...
 }

Update Convention

 PUT /api/convention/xxx

Returns the same as a normal read.

Delete Convention

 DELETE /api/convention/xxx

Returns:

 {
   "success" : 1
 }

Search Users

There are lots of functions where you'll need to assign a User id, so you'll need to be able to look up users. However, since you are not a site administrator you don't have the rights to look up users through the normal API. This API gives you a limited view of users that includes some data the normal User API wouldn't if you are a convention runner. It requires you to be logged in.

 GET /api/convention/xxx/user
Optional Params
badge_number

Look up a user by a specific badge nubmer in your convention.

badge_name

Look up users by a partial badge name in your convention.

query

Generically search users based upon partial usernames, real names, or email addresses.

Returns:

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

Search Financials

Like ledgerentries but with special searching capabilities.

 GET /api/convention/xxx/financials
Optional Params
badge_name

Use this field to do a partial search on badge name.

order_number

Limit ledger entries to a specific order number.

Collect Ticket

Marks a Ticket collected. Will reject generic tickets.

 POST /api/convention/xxx/collect-ticket
Required Params
ticket_number

Returns the same as a Ticket read.

Collect Generic Ticket

Marks a generic Ticket collected. Will reject a normal ticket.

 POST /api/convention/xxx/collect-ticket
Required Params
ticket_number
event_id

Returns the same as a Ticket read.

Badge Summary

Summarizes the state of all your badges.

 GET /api/convention/xxx/badge-summary

Returns

 {
     "checked_in" : 43,
     "printed" : 172,
     "sold" : 531,
     "in_carts" : 4,
     "verified" : 546,
 }

verified are all badges that are valid. Therefore, if you subtract sold from verified you'd know how many badges are administratively created.

Badge Sales History

Summarizes when badges were purchased.

 GET /api/convention/xxx/badge-sales-history

Returns

 {
     "sales" : [
        {
            "month" : "2017-01",
            "total_sales" : 13,
        },
        ...
     ]
 }