Conventions are accessed via /api/convention.
See "Object Properties" in Introduction for basic shared properties.
Complete details in ConventionProperties. It also has these extra read-only properties:
Indicates if the convention allows attendee reservations.
Indicates if the convention allows host seat reservations at an event they host.
Indicates if event reservations are open and currently not suspended.
Indicates whether the convention has ended.
Indicates whether the convention has enabled scheduling.
Note that all long-text fields from the Conventions table have been relocated to separate tables.
These are text and blob fields,
which respectivetly are used to store HTML or JSON data (not necessarily in all cases).
See below under "Includes" and "Relationships" for more information.
See "Related Objects" in Introduction for how to use them.
A ConventionImage that will be used to generate printed Badges.
A GeoLocation of the general area where the convention will be held.
A Group that is in charge of the convention.
A ConventionImage that will be displayed at the top of all the convention's pages.
A Library that will be available at the convention, if any.
A Venue where the convention will be held.
A ConventionImage that shows the map of the convention Venue.
See "Relationships" in Introduction for how to use them.
Badges created for this convention.
BadgeTypeCategorys created for this convention.
BadgeTypes created for this convention.
BadgeTypeEventTypes created for this convention.
BoothOptions created for this convention.
Booths created for this convention.
BoothTypes creeated for this convention.
ConventionCarts created for this convention.
CashDrawers created for this convention.
ConventionJson data for this convention.
These are stored separately from the convention record because they can contain a lot data that is needed only in specific circumstances.
(You can also access these convention child objects under external_jsons.) These fields include:
You can _include these fields.
See the "Includes" section.
ConventionWebfiltered data for this convention.
These are stored separately from the convention record because they can contain a lot data that is needed only in specific circumstances.
(You can also access these convention child objects under external_webfiltereds.) These fields include:
You can _include these fields.
See the "Includes" section.
DayParts created for this convention.
ConventionDays created for this convention.
Discounts created for this convention.
Events created for this convention.
EventGroups created for this convention.
EventGroupBadgeTypes created for this convention.
EventGroupEvents created for this convention.
EventSessions created for this convention.
EventSubmissions created for this convention.
The real_name of the event submitter.
EventSubmissionSessions created for this convention.
EventTypeRooms created for this convention.
EventTypes created for this convention.
EventWaits created for this convention.
EventWarningss for events of this convention.
The text of the warning.
Exhibitors created for this convention.
ConventionImages created for this convention.
LedgerEntrys created for this convention.
The LibraryGameCheckouts associated with this convention.
Pages created for this convention.
The PlayToWins associated with this convention.
ConventionPrivileges created for this convention.
Products created for this convention.
ProductVariants created for this convention.
Prototypes created for this convention.
ConventionReceipts created for this convention.
Rooms created for this convention.
RoomZones created for this convention.
Shifts created for this convention.
The room_id field in the Shift's related ShiftType.
You must include parameter _include_related_objects=shifttype with the request for this to work.
ShiftTypes created for this convention.
Slots created for this convention.
SoldProducts created for this convention.
Spaces created for this convention.
The Sponsorships available to Exhibitors for the convention.
The exhibitor Sponsors for the convention.
The SupplyOrders for the convention.
Tickets created for this convention.
News Updates created for this convention.
Volunteers for this convention.
VolunteerShifts created for this convention.
The firstname field in the VolunteerShift's related Volunteer record.
You must include parameter _include_related_objects=volunteer with the request for this to work.
The lastname field in the VolunteerShift's related Volunteer record.
You must include parameter _include_related_objects=volunteer with the request for this to work.
The conventionday_id field in the VolunteerShift's related Shift record.
You must include parameter _include_related_objects=shift with the request for this to work.
The user_id field in the VolunteerShift's related Volunteer record.
You must include parameter _include_related_objects=volunteer with the request for this to work.
See "Includes" in Introduction for how to use them.
Indicates that the convention's group's leader has set up the convention to receive payouts. Convention sales cannot occur if payout is not set up or if it changes to a state where it is not set up (e.g., if the convention group leader were to change to one without their payout setup completed).
See ConventionJson for the list of specific JSON "fields" you can include.
See ConventionWebfiltered for the list of specific webfiltered (HTML) "fields" you can include.
The services used to fetch and manipulate 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
A partial convention name.
Returns:
{
"items" : [
{
"id" : "xxx",
"name" : "Big Apple Con 2017",
...
},
...
],
"paging" : {...}
}
POST /api/convention
Returns the same as a normal read.
GET /api/convention/xxx
Returns:
{
"id" : "xxx",
"name" : "Big Apple Con 2017",
...
}
PUT /api/convention/xxx
Returns the same as a normal read.
DELETE /api/convention/xxx
Returns:
{
"success" : 1
}
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
Look up a user by a specific badge nubmer in your convention.
Look up users by a partial badge name in your convention.
Generically search users based upon partial display names or real names, or exact matches for email addresses, if the user has set their account email to be visible to organizers.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"display_name" : "Joe User",
...
},
...
]
}
Like ledgerentries but with special searching capabilities.
GET /api/convention/xxx/financials
Use this field to do a partial search on badge name.
Limit ledger entries to a specific order number.
Limit ledger entries to a specific category.
Marks a Ticket collected. Will reject generic tickets.
POST /api/convention/xxx/collect-ticket
Returns the same as a Ticket read.
Marks a generic Ticket collected. Will reject a normal ticket.
POST /api/convention/xxx/collect-ticket
Returns the same as a Ticket read.
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.
Summarizes when badges were purchased.
GET /api/convention/xxx/badge-sales-history
Returns:
{
"sales" : [
{
"month" : "2017-01",
"total_sales" : 13,
},
...
]
}
A list of Users that run convention Events. Th
GET /api/convention/xxx/hosts
Returns:
{
"paging" : {...},
"items" : [
{
"firstname": "Host",
"lastname": "McHoster",
...
},
...
]
}
The list of ConventionDays that have associated Shifts.
GET /api/convention/xxx/days/with-shifts
The list of Rooms that have associated Shifts.
GET /api/convention/xxx/rooms/with-shifts
Creates a Wingman job to send a message to convention Volunteers.
POST /api/convention/xxx/message-volunteers
Returns:
{ "success": 1 }
The list of Convention Volunteers by their VolunteerShift status. Note that the different endpoints can return the same volunteer(s). If a volunteer has a scheduled shift, and an unscheduled shift, that volunteer will be included in both the scheduled and unscheduled lists.
GET /api/convention/xxx/volunteers/scheduled GET /api/convention/xxx/volunteers/unscheduled GET /api/convention/xxx/volunteers/declined
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"firstname": "Joe",
"lastname": "Volunteer",
...
},
...
]
}
The count of Convention Volunteers by their VolunteerShift status. Note that the different endpoints can count the same volunteer(s). If a volunteer has a scheduled shift, and an unscheduled shift, that volunteer will be included in the counts of both the scheduled and unscheduled volunteers.
GET /api/convention/xxx/volunteers/scheduled/count GET /api/convention/xxx/volunteers/unscheduled/count GET /api/convention/xxx/volunteers/declined/count
Returns:
{
"scheduled_volunteers_count" : 5
}
Or unscheduled_volunteers_count, or declined_volunteers_count.
The list of Shifts that still need Volunteers.
GET /api/convention/xxx/shifts/available
Limit shifts to those for a specific ConventionDay.
Limit shifts to those for a specific Room.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "Sunday Morning Shift",
...
},
...
]
}
The list of ConventionDays that are of type Event.
GET /api/convention/xxx/event-days
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "Day 1",
"day_type" : "events",
...
},
...
]
}
Activity information, if any, associated with all badges for the convention.
Entries are returned in reverse order by creation date.
GET /api/convention/xxx/badgelogs
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"type" : "Comment",
"commenter_name" : "Joe Commenter",
...
},
...
]
}