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_uri_exhibitor: If the booth has an exhibitor, then this URI will be included. It links to the page where you can manage the exhibitor booth extras.

Related Objects

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

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.

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

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

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/assign

Required Params

exhibitor_id

Returns the same as a normal read.

Get Booth's Complimentary SoldProducts

Gets the SoldProducts that were complimentary with the booth.

 GET /api/booth/xxx/soldproducts/complimentary

Returns the SoldProducts in list format:

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

Unclaim Booth

Unassign an exhibitor from 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.

Convert Booth to Free

This refunds a charge for a booth without unclaiming it. Use of this endpoint requires the exhibitors privilege.

 PUT /api/booth/xxx/convert/free

Returns the same as a normal read.

Convert Booth (for exhibitors)

(See also Convert Booth for organizers, below.)

Convert an exhibitor's booth purchase to a different booth. This will move the exhibitor to the new booth, and charge or refund the difference in the booths' costs. This cannot be used for organizer-granted booths.

 POST /api/booth/xxx/convert/to-booth/:to_booth_id

Required Params

to_booth_id: The ID of the booth to which the Exhibitor is to be moved. The destination booth cannot be already claimed. It can be reserved if the user has the exhibitors privilege (not an exhibitor).

Returns a normal read of the booth converted to.

Convert Booth (for organizers)

(See also Convert Booth for exhibitors, above.)

Move this booth's Exhibitor to a different booth. Use of this endpoint requires the exhibitors privilege.

Note this does double-duty. It can just move an exhibitor to another booth, or convert that exhibitor's booth purchase to a different booth (which therefore also moves the exhibitor to that booth).

 PUT /api/booth/xxx/convert

Required Params

to_booth_id: The ID of the booth to which the Exhibitor is to be moved. The destination booth cannot be already claimed. It can be reserved.

Optional Params

move_no_charge: Can be 1 (true) or 0 (false). If true, means the move will be done without any charge or refund for the difference in the booth prices. If the booth was paid for with cash, you must set this to true for the move to succeed.

Returns the same as a normal read.

Swap Convert Booths

Swap this booth's Exhibitor and another booth's Exhibitor between the two booths.

This will result in 3 moves. The first Exhibitor is moved to a temporary booth. The second Exhibitor is then moved to the first booth. Finally the first Exhibitor is moved to the second booth. Note that the first booth is referred to below as the "move booth", and its Exhibitor (the first exhibitor) is the "move exhibitor". Likewise, the second booth/Exhibitor is referred to as the "swap booth" and "swap exhibitor".

 PUT /api/booth/xxx/convert-swap

Required Params

to_booth_id

The ID of the booth to which the Exhibitor is to be moved (the "swap booth").

Optional Params

move_no_charge

Can be 1 (true) or 0 (false). If true, means the primary move ("move") will be done without any charge or refund for the difference in the booth prices. If the booth was paid for with cash, you must set this to true for the move to succeed.

swap_no_charge

Can be 1 (true) or 0 (false). If true, means the secondary move ("swap") will be done without any charge or refund for the difference in the booth prices. If the booth was paid for with cash, you must set this to true for the swap move to succeed.

Returns the same as a normal read.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 288:: =over without closing =back

Developer Documentation

Introduction