Booth OpCode BI: Add New Booth
Booth OpCode BI: Add New Booth
This opcode is used to add a new Booth to the specified show. Booths are created under an exhibitor, and each exhibitor can have multiple booths. The exhibitor to create the booth under may be identified by specifying the ExhibitorKey or the ExhibitorExternalID parameters. Booth Titles must be unique across the show.
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation (except for file uploading which requires a multi-part form post). Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50550&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&{Additional, opcode-specific parameters in name=value format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50550. All other parameters may appear in any sequence order.
|
API Parameter |
Type/Size |
Req. |
Comment |
|---|---|---|---|
|
APIUserAuthCode |
Varchar 80 |
Y |
Your API authorization code as supplied by Notified. |
|
APIUserCredentials |
Varchar 80 |
Y |
Your API user credentials as supplied by Notified. |
|
OpCodeList |
Varchar 2000 |
Y |
Should include BI to invoke this function. |
|
OutputFormat |
Char 1 |
N |
T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
|
ShowKey |
Integer |
Y |
Show Key to create the booth in. |
|
ExhibitorKey |
Integer |
N |
Exhibitor Key value to create the booth under. |
|
ExhibitorExternalID |
Varchar 25 |
N |
External ID or code to cross-reference this exhibitor entry to create the booth under. |
|
BoothTitle |
Varchar 128 |
Y |
Title of the booth. |
|
Description |
Varchar 255 |
Y |
Description of this booth. |
|
BoothLayoutKey |
Integer |
N |
The key-value indicating the layout template to use when rendering this booth. If omitted, one will be selected by the system. (see opcode BL) |
|
PrivateBooth |
Bit (0/1) |
N |
Flag indicating whether this booth is private (1) or public (0). |
|
AllowStaffToSeeVisitTab |
Bit (0/1) |
N |
Control flag indicating whether booth staffers can see the special in-booth visits reporting tab. |
|
BoothTypeKey |
Integer |
N |
Key-value indicating the type of booth this is. If omitted, one will be selected by the system. (See opcode BT) |
|
BoothMessage |
Varchar 2000 |
N |
Message or greeting displayed in the booth. |
|
SearchTermsList |
Varchar 1000 |
N |
List of search terms, separated by spaces, used to locate this booth when searching the show. |
|
BoothContactKey |
Integer |
N |
A valid Show User Key identifying the main booth administrator. If not specified, the system will attempt to look this up from the Exhibitor Contact value, if defined, or a person associated with this exhibitor. |
|
ApprovalLevel |
Integer (0-3) |
N |
Approval level for this booth. Values: 0 = unsubmitted 1 = submitted 2 = approved 3 = rejected |
|
BoothImage |
Varchar 255 |
N |
URL identifying the image/logo for this booth. |
|
BillingMemo |
Varchar 2GB |
N |
Additional comments and notes regarding this booth. |
|
BoothExternalID |
Varchar 255 |
N |
External ID or code to cross-reference this booth entry. |
|
LocaleID |
Integer |
N |
Locale ID indicating the default language of this booth. (See Locale ID reference in the External User API documentation for a list of values) |
|
BoothTemplateKey |
Integer |
N |
Key-value indicating the template to use when creating the booth. Templates can be defined allowing the creation of standard Booth Builder parameters, tabs, giveaways, and tab security. (See opcode BX) |
|
CreateDefaultTab |
Bit (0/1) |
N |
If the value is one (1) and BoothTemplateKey is not specified, this will create a default tab of type External URL, labeled About Us pointing to the WebSiteURL value defined for the Exhibitor. |
|
BoothUDFList |
Varchar 2GB |
N |
User-defined field data for this booth. (See Passing UDF Values reference in the External User API documentation for format details) |
|
APIUserAuthCode |
varchar 80 |
Y |
Your API authorization code as supplied by Notified. |
|
APIUserCredentials |
Varchar 80 |
Y |
Your API user credentials as supplied by Notified. |
|
OpCodeList |
Varchar 2000 |
Y |
Should include BI to invoke this function. |
|
BoothTemplateKey |
Integer |
N |
Key-value indicating the template to use when creating the booth. Templates can be defined allowing the creation of standard Booth Builder parameters, tabs, giveaways, and tab security. (See opcode BX) |
|
CreateDefaultTab |
Bit (0/1) |
N |
If the value is one (1) and BoothTemplateKey is not specified, this will create a default tab of type External URL, labeled About Us pointing to the WebSiteURL value defined for the Exhibitor. |
|
BoothUDFList |
Varchar 2GB |
N |
User-defined field data for this booth. (See Passing UDF Values reference in the External User API documentation for format details) |
Return Outputs
This API returns the status message OK and the new BoothKey upon successful completion.
Text
### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=BI Status=0 Message=OK
BoothKey
123456
HTTP URL-encoded
APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=BI&Status=0&Message=OK&BoothKey=123456
XML
<?xml version="1.0" encoding="utf-8" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="BI" Status="0" Message="OK" >
<ResultRow>
<BoothKey>123456</BoothKey>
</ResultRow>
</OpCodeResult>
</APIResults>
|
Error |
Message |
Reason |
|---|---|---|
|
501 |
Invalid Or Missing Exhibitor! |
The exhibitor to create the booth for could not be found based on the values passed for ExhibitorKey and ExhibitorExternalID. |
|
502 |
Invalid Or Missing Show! |
The ShowKey parameter was invalid or not supplied. |
|
503 |
A Booth With This External ID Already Exists! |
If passing BoothExternalID, this value must be unique across booths in this show. |
|
504 |
A Booth With This Name Already Exists! |
Booth titles must be unique in the show. |
|
505 |
Invalid Or Missing Booth Name! |
The BoothTitle parameter was empty or not supplied. |
|
506 |
Invalid Or Missing Booth Type! |
The BoothTypeKey parameter specified is invalid. |
|
507 |
Invalid Booth Contact Specified! |
The BoothContactKey specified is invalid in the list of Show Users. |
|
508 |
Invalid Or Missing Booth Layout! |
The BoothLayoutKey specified is invalid. |
|
509 |
Invalid Booth Template Specified! |
The BoothTemplateKey specified is invalid. |
|
510 |
Invalid Language ID! |
The value specified in LocaleID is invalid. |
|
511 |
Missing Booth Description |
The Description parameter is empty or omitted. |