BoothAddOn

Booth add ons are configured versions of BoothOptions. Booth Add Ons are accessed via /api/boothaddon.

Properties

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

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

shortname

A unique name that can be used to easily identify this booth add on.

Related Objects

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

booth

The Booth that this add on is configured for.

BoothOption

The BoothOption that this add on is based upon.

convention

The Convention this booth add on belongs to.

conventioncart

The ConventionCart this booth add on sits in (if any).

conventionreceipt

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

discount

The Discount used on this booth add on (if any).

exhibitor

The Exhibitor that ordered this add on.

Includes

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

longname

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

Services

The services used to fetch and manipulate boothaddons.

Search Booth Add Ons

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

Create Booth Add On

You almost certainly mean to use the ConventionCart API to do it instead.

 POST /api/boothaddon

Required Params

session_id

convention_id

boothoption_id

exhibitor_id

booth_id

Returns the same as a normal read.

Administratively Create Booth Add On

This will create a booth add on for free and will be marked as verified. If you want the exhibitor to pay for it, then you'll want to use the ConventionCart API to do it instead.

Required Params

The same parameters as the normal Create Booth Add On service.

Returns the same as a normal read.

Read Booth Add On

 GET /api/boothaddon/xxx

Returns:

 {
   "id" : "xxx",
   "boothoption_id" : "xxx",
   ...
 }

Update Booth Add On

 PUT /api/boothaddon/xxx

Returns the same as a normal read.

Delete Booth Add On

 DELETE /api/boothaddon/xxx

Returns:

 {
   "success" : 1
 }

Convert Booth Add-On to Free

This refunds a charge for a booth add-on without deleting it. Use of this endpoint requires the exhibitors privilege.

 PUT /api/boothaddon/xxx/convert/free

Returns the same as a normal read.

Convert Booth Add-On

Convert an exhibitor's booth add-on purchase to a different BoothOption. This will charge or refund the difference in the costs. This cannot be used for organizer-granted booth add-ons.

 POST /api/boothaddon/xxx/convert/boothoption/:boothoption_id

Required Params

boothoption_id

The ID of the BoothOption to convert the add-on to.

Returns a normal read of the add-on converted to.