Booth

Booths are rented by Exhibitors during a Convention as a temporary retail location to sell their wares. Requires the exhibitors ConventionPrivilege Booths are accessed via /api/booth.

Properties

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

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

edit_exhibitor_uri

If an exhibitor has been assigned to this booth, then this URL will be included and it links to the web page where you can manage an exhibitor.

Related Objects

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

boothtype

The BoothType that controls this booth.

convention

The Convention this booth belongs to.

exhibitor

The Exhibitor that has claimed this booth (if any).

room

The Room in which this booth is located.

roomzone

The RoomZone in which this booth is located (if any).

Relationships

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

badges

The list of Badges that were given away for free with this booth.

=

boothaddons

The list of BoothAddons configured for this booth.

Includes

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

boothoptions

Returns list of BoothOptions associated with the BoothType that this booth is controlled by.

boothaddons

Returns a list of BoothAddOns that have been configured to be attached to this booth. Can also be accessed with the boothaddons relationship, but often you want to display both at the same time so this just makes things a bit more convenient.

longname

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

Services

The services used to fetch and manipulate booths.

Search Booths

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

 GET /api/booth
Optional Params
query

Searches a partial name.

Returns:

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

Create Booth

 POST /api/booth
Required Params
session_id
name
convention_id
boothtype_id
room_id

Returns the same as a normal read.

Read Booth

 GET /api/booth/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "104",
   ...
 }

Update Booth

 PUT /api/booth/xxx

Returns the same as a normal read.

Delete Booth

 DELETE /api/booth/xxx

Returns:

 {
   "success" : 1
 }

Administratively Assign Booth

Assign an exhibitor to a booth. If you you don't have the exhibitors ConventionPrivilege then you'll want to use the ConventionCart API instead.

 POST /api/booth/xxx/claim
Required Params
exhibitor_id

Returns the same as a normal read.

Unclaim Booth

Unassign an exhibitor to a booth. If you don't have the exhibitors ConventionPrivilege then you'll need to control the Exhibitor assigned to this booth to call this.

 POST /api/booth/xxx/unclaim

Returns the same as a normal read.