Exhibitor OpCode EI: Add New Exhibitor

Exhibitor OpCode EI: Add New Exhibitor

This opcode is used to add a new Exhibitor to the tenant area. Exhibitors span multiple shows within a tenant. Exhibitor names must be unique across the tenant.

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 EI to invoke this function.

OutputFormat

Char 1

N

T for text, H for HTTP URL-encoded, or X for XML. Defaults to T.

ExhibitorExternalID

Varchar 255

N

External ID or code to cross-reference this exhibitor entry.

ExhibitorName

Varchar 80

Y

Name for this exhibitor.

Address

Varchar 2000

N

Address for this exhibitor.

ExhibitorTypeKey

Integer

N

Type Key indicating the type of exhibitor this is. (See opcode ET)

ExhibitorStatusKey

Integer

N

Status Key indicating the status of this exhibitor. (See opcode ES)

BillingContact

Varchar 80

N

Contact person at this exhibitor company.

BillingContactEMailAddress

Varchar 255

N

Email address for the contact person at this exhibitor company.

BillingContactPhone

Varchar 255

N

The phone number for the contact person at this exhibitor company.

WebSiteURL

Varchar 255

N

Website URL, starting with http:// or https://.

ExhibitorUDFList

Varchar 2GB

N

User-defined field data for this exhibitor. (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 ExhibitorKey upon successful completion.

 

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=EI Status=0 Message=OK

ExhibitorKey

123456

 

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=EI&Status=0&Message=OK&ExhibitorKey=123456

 

XML

<?xml version="1.0" encoding="utf-8" ?>

<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >

<OpCodeResult OpCode="EI" Status="0" Message="OK" >

 <ResultRow>

  <ExhibitorKey>123456</ExhibitorKey>

 </ResultRow>

</OpCodeResult>

</APIResults>

 

Error

Message

Reason

101

An Exhibitor With This External ID Already Exists!

The value passed for ExhibitorExternalID already exists associated with another exhibitor. This value must be blank or unique.

102

An Exhibitor With This Name Already Exists!

An Exhibitor with this name already exists. Exhibitor names must be unique.

103

Invalid Or Missing Name!

The name parameter was empty or omitted.

104

Invalid Or Missing Exhibitor Type!

The ExhibitorTypeKey parameter value that was specified is invalid.

105

Invalid Or Missing Exhibitor Status!

The ExhibitorStatusKey parameter value that was specified is invalid.