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.
See "Object Properties" in Introduction for basic shared properties.
Complete details in BoothProperties. It also has these extra read-only properties:
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.
See "Related Objects" in Introduction for how to use them.
The BoothType that controls this booth.
The Convention this booth belongs to.
The Exhibitor that has claimed this booth (if any).
The Room in which this booth is located.
The RoomZone in which this booth is located (if any).
See "Relationships" in Introduction for how to use them.
The list of Badges that were given away for free with this booth.
The list of BoothAddons configured for this booth.
See "Includes" in Introduction for how to use them.
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.
A very descriptive name for this booth. It pulls data from several objects, which is why it is not included by default.
The services used to fetch and manipulate booths.
This will search across all conventions. To search on a single convention see "Relationships" in Convention.
GET /api/booth
Searches a partial name.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "104",
...
},
...
]
}
POST /api/booth
Returns the same as a normal read.
GET /api/booth/xxx
Returns:
{
"id" : "xxx",
"name" : "104",
...
}
PUT /api/booth/xxx
Returns the same as a normal read.
DELETE /api/booth/xxx
Returns:
{
"success" : 1
}
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
Returns the same as a normal read.
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",
...
},
...
]
}
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.
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.
(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
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.
(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
The ID of the booth to which the Exhibitor is to be moved. The destination booth cannot be already claimed. It can be reserved.
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 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) or0(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) or0(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.
Hey! The above document had some coding errors, which are explained below:
=over without closing =back