EXPOCAD is a Professional Event Floor Plan Management Software Specifically Created for Show Organizers and Operations Teams to Manage Exhibitors and Exposition Space. Multi-Event Management - Any Venue - Any Size - Indoors or Out
Status: Preview |
Tier: Premium |
Version: v3 |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get Specific Booth
Description: Returns the specified booth.
Syntax:
EXPOCAD.Booths_Get (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booth
Default Value: { "Area": "100 SqFt", "BoothClasses": [ "Standard Booth" ], "BoothNumber": "100", "BoothType": "Inline", "ChildExhibitors": [ "T0000002", "T0000003" ], "Dimensions": "10' x 10'", "DisplayNameOverride": "", "ExhibitorId": "T0000001", "HoldComment": "", "HoldExhibitorId": "", "HoldExhibitorName": "", "IsDeleted": false, "IsOnHold": false, "IsRented": true, "OpenCorners": 0, "Pavilion": "Fruit Pavilion", "ShowInShow": "Fruit Show", "Status": "Initial", "UnitType": "ftin", "XSize": "10'", "YSize": "10'" }
Summary: Get All Booths
Description: Returns an array of all booths in the supplied event.
Syntax:
EXPOCAD.Booths_GetAllBooths (string ClientName, string databaseName, [Optional]string deletedFilter)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
deletedFilter |
string (deletedFilter)Values: [IncludeAll, OnlyNonDeleted, OnlyDeleted] |
Filter by deleted booths. Default includes only non deleted booths. |
False |
Returns:
Type:array of (Booth)
Summary: Get All Available Booths
Description: Returns a collection of all available booths in the supplied event.
Syntax:
EXPOCAD.Booths_GetAllAvailableBooths (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (Booth)
Summary: Get All Rented Booths
Description: Returns a collection of all rented booths in the supplied event
Syntax:
EXPOCAD.Booths_GetAllRentedBooths (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (Booth)
Summary: Change the number of the specified booth
Description: Changes the number of the specified booth in the supplied event
Syntax:
EXPOCAD.Booths_ChangeBoothNumber (string ClientName, string oldNumber, string newNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
oldNumber |
string (oldNumber) |
The booth number of the existing booth to change. |
True |
|
newNumber |
string (newNumber) |
The new booth number to be assigned. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_ChangeBoothNumberResponse
Summary: Add a child exhibitor to the specified booth
Description: When adding a child exhibitor, the child exhibitor must already exist.
Syntax:
EXPOCAD.Booths_AddChildExhibitor (string ClientName, string childExhibitorId, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
childExhibitorId |
string (childExhibitorId) |
The ID of the child exhibitor. |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_AddChildExhibitorResponse
Summary: Remove a child exhibitor from the specified booth
Description: Removes a child exhibitor from the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_RemoveChildExhibitor (string ClientName, string childExhibitorId, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
childExhibitorId |
string (childExhibitorId) |
The ID of the child exhibitor. |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_RemoveChildExhibitorResponse
Summary: Apply a single booth class to the specified booth
Description: Applys a single booth class to the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_SetBoothClass (string ClientName, string classId, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
classId |
string (classId) |
The class ID of the booth class. |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_SetBoothClassResponse
Summary: Remove a single booth class from the specified booth
Description: Removes a single booth class from the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_ClearBoothClass (string ClientName, string classId, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
classId |
string (classId) |
The class ID of the booth class. |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_ClearBoothClassResponse
Summary: Combine the specified booths into a new booth
Description: Combines the specified booths into a new booth in the supplied event.
Syntax:
EXPOCAD.Booths_CombineBooths (string ClientName, array boothNumbers, string databaseName, integer boundary)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumbers |
array of (string)
|
|
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
boundary |
integer(int32) (boundary) |
0 or 1 |
True |
Returns:
Type:Booths_CombineBoothsResponse
Summary: Delete the specified booths
Description: Deletes the specified booths in the supplied event.
Syntax:
EXPOCAD.Booths_DeleteBooths (string ClientName, array boothNumbers, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumbers |
array of (string)
|
|
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_DeleteBoothsResponse
Summary: Reset the display on drawing override for the specified booth
Description: Resets the display on drawing override for the specified booth.
Syntax:
EXPOCAD.Booths_ClearBoothDisplayName (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_ClearBoothDisplayNameResponse
Summary: Override the display on drawing property for the specified booth
Description: Overrides the display on drawing property for the specified booth.
Syntax:
EXPOCAD.Booths_SetBoothDisplayName (string ClientName, string text, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
text |
string (text) |
The text to override the display on drawing. |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_SetBoothDisplayNameResponse
Summary: Holds the specified booth
Description: EXPOCAD allows for a booth to be placed on hold to either an existing Exhibitor (by Id) or to a temporary Exhibitor (by Name).<br /> Choose one parameter or the other - 'ExhibitorId' or 'ExhibitorName'.<br /><br /> If both paramerters are supplied, the hold will default to the Exhibitor ID.
Syntax:
EXPOCAD.Booths_HoldBooth (string ClientName, string boothNumber, string databaseName, [Optional]string exhibitorId, [Optional]string exhibitorName, [Optional]string comment)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
exhibitorId |
string (exhibitorId) |
The ID of the exhibitor. |
False |
|
exhibitorName |
string (exhibitorName) |
The name of the exhibitor. |
False |
|
comment |
string (comment) |
Comments regarding the hold. |
False |
Returns:
Summary: Convert Held booth to Rented
Description: Rents the specified held booth to the held exhibitor in the supplied event. This operation will fail if the booth is currently held to a temporary exhibitor.
Syntax:
EXPOCAD.Booths_HoldToRent (string ClientName, string boothNumber, string databaseName, [Optional]string ratePlan)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
ratePlan |
string (ratePlan) |
The rate plan name. |
False |
Returns:
Type:Booths_HoldToRentResponse
Summary: Rent a Booth
Description: Rents the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_RentBooth (string ClientName, string boothNumber, string exhibitorId, string databaseName, [Optional]string ratePlan, [Optional]string status, [Optional]string comment)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
exhibitorId |
string (exhibitorId) |
The ID of the exhibitor. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
ratePlan |
string (ratePlan) |
The rate plan name. |
False |
|
status |
string (status) |
A status for the rented booth |
False |
|
comment |
string (comment) |
A comment for the rented booth |
False |
Returns:
Summary: Convert Rented booth to Hold
Description: Converts the specified rented booth to a booth on hold to the same exhibitor in the supplied event.
Syntax:
EXPOCAD.Booths_RentToHold (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_RentToHoldResponse
Summary: Uncombine the specified booth
Description: Uncombines the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_UncombineBooth (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_UncombineBoothResponse
Summary: Undelete the specified booths
Description: Undeletes the specified booths in the supplied event.
Syntax:
EXPOCAD.Booths_UndeleteBooths (string ClientName, array boothNumbers, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumbers |
array of (string)
|
|
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_UndeleteBoothsResponse
Summary: Unholds the specified booth
Description: Unholds the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_UnHoldBooth (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_UnHoldBoothResponse
Summary: Unrent a Booth
Description: Unrents the specified booth in the supplied event.
Syntax:
EXPOCAD.Booths_UnRentBooth (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Booths_UnRentBoothResponse
Summary: Return the specified booth class
Description: Returns the specified booth class.
Syntax:
EXPOCAD.Classes_Get (string ClientName, string classId, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
classId |
string (classId) |
The class ID of the booth class. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:BoothClass
Default Value: { "Color": 6, "CountAsInventory": 1, "Description": "Booth space designated to show management.", "Id": "ShowManagement", "KeepWhenCombined": 1, "Name": "Show Management", "Prioritity": "10" }
Summary: Add a new booth class
Description: Adds a new booth class to the supplied event.
Syntax:
EXPOCAD.Classes_Create (string ClientName, BoothClass boothClass, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothClass |
|
|
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:BoothClass
Default Value: { "Color": 6, "CountAsInventory": 1, "Description": "Booth space designated to show management.", "Id": "ShowManagement", "KeepWhenCombined": 1, "Name": "Show Management", "Prioritity": "10" }
Summary: Return a collection of all booth classes
Description: Returns a collection of all booth classes in the supplied event.
Syntax:
EXPOCAD.Classes_GetAllBoothClasses (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (BoothClass)
Summary: Delete a booth class
Description: Deletes a booth class in the supplied event.
Syntax:
EXPOCAD.Classes_Delete (string ClientName, string classId, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
classId |
string (classId) |
The class Id of the booth class. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Summary: Update the specified booth class
Description: Updates the specified booth class.
Syntax:
EXPOCAD.Classes_Update (string ClientName, BoothClass boothClass, string classId, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothClass |
|
|
True |
|
classId |
string (classId) |
The class ID of the booth class. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:BoothClass
Default Value: { "Color": 6, "CountAsInventory": 1, "Description": "Booth space designated to show management.", "Id": "ShowManagement", "KeepWhenCombined": 1, "Name": "Show Management", "Prioritity": "10" }
Summary: Get All Events
Description: Returns a collection of registered events.
Syntax:
EXPOCAD.Events_GetAllEvents (string ClientName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (ClientName) |
ClientName |
True |
Returns:
Type:Events_GetAllEventsResponse
Summary: Get Event Information
Description: Returns basic information about the supplied event.
Syntax:
EXPOCAD.Events_GetEventInformation (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:ExpoEventInformation
Default Value: { "ContractorName": "Deco Decorators", "ContractorPhone": "555-555-5555", "DatabaseName": "demo", "EventDescription": "The World's Only Gathering of Fruit and Nuts", "EventExhibitorFile": "demoa", "EventLocation": "San Diego Convention Center", "EventLocation2": "San Diego, CA", "EventName": "demo", "ShowDates": "Annual Fruit & Nut EXPO", "ShowTitle": "Dec. 15 - 19, 2016" }
Summary: Get Event Statistics
Description: Returns basic statistics describing the supplied event.
Syntax:
EXPOCAD.Events_GetEventStatistics (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:EventStats
Default Value: { "AvailableBoothArea": "73470.00", "AvailableBoothPercentage": "66.87", "AvailableBooths": "603", "NetValueSold": "255,000.00", "NonInventoryBoothArea": "0.00", "NonInventoryBooths": "0", "RentedBoothArea": "36400.00", "RentedBoothPercentage": "33.13", "RentedBooths": "59", "TotalBoothArea": "109870.00", "TotalBooths": "662", "TotalExhibitors": "42" }
Summary: Get an Exhibitor
Description: Returns the specified exhibitor.
Syntax:
EXPOCAD.Exhibitors_Get (string ClientName, string id, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
id |
string (id) |
The ID of the exhibitor. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Exhibitor
Default Value: { "Address1": "678 Benton Street", "Address2": "Suite 10", "City": "Aurora", "Contact": "John Smith", "Country": "United States", "DisplayOnDrawing": "ABC Company", "Email": "john.smith@abccompany.com", "ExhibitorId": "T0000001", "ExhibitorName": "ABC Company", "Fax": "555-555-5555", "Phone": "555-555-5555", "PostalCode": "60505", "PrimaryGroup": "Kitchen Supplies", "State": "IL", "WebSite": "http://www.abccompany.com" }
Summary: Add a new exhibitor
Description: Adds a new exhibitor to the supplied event.
Syntax:
EXPOCAD.Exhibitors_AddExhibitor (string ClientName, Exhibitor exhibitor, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
exhibitor |
|
|
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Exhibitor
Default Value: { "Address1": "678 Benton Street", "Address2": "Suite 10", "City": "Aurora", "Contact": "John Smith", "Country": "United States", "DisplayOnDrawing": "ABC Company", "Email": "john.smith@abccompany.com", "ExhibitorId": "T0000001", "ExhibitorName": "ABC Company", "Fax": "555-555-5555", "Phone": "555-555-5555", "PostalCode": "60505", "PrimaryGroup": "Kitchen Supplies", "State": "IL", "WebSite": "http://www.abccompany.com" }
Summary: Get All Exhibitors
Description: Returns a collection of all exhibitors in the supplied event.
Syntax:
EXPOCAD.Exhibitors_GetAllExhibitors (string ClientName, [Optional]string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (ClientName) |
ClientName |
True |
|
databaseName |
string (databaseName) |
databaseName |
False |
Returns:
Type:Exhibitors_GetAllExhibitorsResponse
Summary: Delete an exhibitor
Description: Deletes an exhibitor in the supplied event.
Syntax:
EXPOCAD.Exhibitors_DeleteExhibitor (string ClientName, string id, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
id |
string (id) |
The ID of the exhibitor. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Exhibitors_DeleteExhibitorResponse
Summary: Update an exhibitor
Description: Updates an exhibitor in the supplied event.
Syntax:
EXPOCAD.Exhibitors_UpdateExhibitor (string ClientName, Exhibitor exhibitor, string id, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
exhibitor |
|
|
True |
|
id |
string (id) |
The ID of the exhibitor. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:Exhibitor
Default Value: { "Address1": "678 Benton Street", "Address2": "Suite 10", "City": "Aurora", "Contact": "John Smith", "Country": "United States", "DisplayOnDrawing": "ABC Company", "Email": "john.smith@abccompany.com", "ExhibitorId": "T0000001", "ExhibitorName": "ABC Company", "Fax": "555-555-5555", "Phone": "555-555-5555", "PostalCode": "60505", "PrimaryGroup": "Kitchen Supplies", "State": "IL", "WebSite": "http://www.abccompany.com" }
Summary: Get financial information for the specified booth
Description: Returns financial information for the specified booth.
Syntax:
EXPOCAD.Financials_Get (string ClientName, string boothNumber, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
boothNumber |
string (boothNumber) |
The booth number of the booth. |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:BoothFinancialInfo
Summary: Get a list of payments in the Expocad Event
Description: Returns list of payments in the Expocad Event.For Non-Credit Card Payments, The Check Number is returned in the CCLast4 field
Syntax:
EXPOCAD.Financials_GetPayments (string ClientName, string databaseName, [Optional]string ExhibitorId, [Optional]string DepositId, [Optional]string InvoiceNumber, [Optional]string StartDate, [Optional]string EndDate, [Optional]string PaymentTypeCategory)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
ExhibitorId |
string (ExhibitorId) |
The Id of an Exhibitor. If omitted, this filter is not applied. |
False |
|
DepositId |
string (DepositId) |
The depositId of a payment. If omitted, this filter is not applied. |
False |
|
InvoiceNumber |
string (InvoiceNumber) |
The number of a particular Invoice. If omitted, this filter is not applied. |
False |
|
StartDate |
string (StartDate) |
The start date of a payment range. If omitted, this filter is not applied. |
False |
|
EndDate |
string (EndDate) |
The end date of a payment range. If omitted, this filter is not applied. |
False |
|
PaymentTypeCategory |
string (PaymentTypeCategory) |
The type a payment. If omitted, this filter is not applied. |
False |
Returns:
Type:array of (InvoicePayment)
Summary: Get the master list of payment types
Description: Returns the master list of payment types.
Syntax:
EXPOCAD.Financials_GetPaymentTypeList (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
Event database name |
True |
Returns:
Type:array of (PaymentTypeItem)
Summary: Returns the master list of requestable items
Description: Will return items that match either the glCode or the transactionCode
Syntax:
EXPOCAD.Financials_GetRequestItemList (string ClientName, string databaseName, [Optional]string glCode, [Optional]string transactionCode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
glCode |
string (glCode) |
The item code of a particular Request Item. If omitted, returns all available Request Items. |
False |
|
transactionCode |
string (transactionCode) |
The transaction code of a particular Request Item. |
False |
Returns:
Type:array of (MasterRequestItem)
Summary: Get a list of all assigned request items
Description: Returns a list of all assigned request items. If any parameter is omitted, that filter will not be applied
Syntax:
EXPOCAD.Financials_GetAssignedRequestItems (string ClientName, string databaseName, [Optional]string exhibitorId, [Optional]string invoiceNumber, [Optional]string startDate, [Optional]string endDate, [Optional]string booth, [Optional]string glCode, [Optional]string transactionCode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
exhibitorId |
string (exhibitorId) |
The Id of an Exhibitor. |
False |
|
invoiceNumber |
string (invoiceNumber) |
The number of an Invoice. |
False |
|
startDate |
string(date-time) (startDate) |
Only items on or after startDate are returned. |
False |
|
endDate |
string(date-time) (endDate) |
Only items on or before endDate are returned. |
False |
|
booth |
string (booth) |
Only items assigned to this booth number are return. |
False |
|
glCode |
string (glCode) |
The item code of a Master Request Item. |
False |
|
transactionCode |
string (transactionCode) |
Only items with this transactionCode are returned |
False |
Returns:
Type:array of (InvoiceRequestItem)
Summary: Get a collection of transactions
Description: Parameters <b>startDate</b> and <b>endDate</b> allow you to filter by a date range. <br />If you do decide to filter by a range, you must supply at least one valid date. <br /><br />Valid dates are in the format of: <b>YYYY-MM-DD</b>
Syntax:
EXPOCAD.Financials_GetAllTransactions (string ClientName, string databaseName, [Optional]string startDate, [Optional]string endDate, [Optional]string exhibitorId, [Optional]string boothNumber, [Optional]string expocadUser, [Optional]string glCode, [Optional]string reversedFilter)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
startDate |
string(date-time) (startDate) |
Filter transactions on and after this date. YYYY-MM-DD |
False |
|
endDate |
string(date-time) (endDate) |
Filter transactions on and before this date. YYYY-MM-DD |
False |
|
exhibitorId |
string (exhibitorId) |
An exhibitor ID to filter by. |
False |
|
boothNumber |
string (boothNumber) |
A booth number to filter by. |
False |
|
expocadUser |
string (expocadUser) |
An expocad user to filter by. |
False |
|
glCode |
string (glCode) |
A general ledger code to filter by. |
False |
|
reversedFilter |
string (reversedFilter)Values: [All, Reversed, NonReversed] |
Filter by reversed transactions. Default includes all transactions. |
False |
Returns:
Type:Transaction
Default Value: { "Amount": "1,000.00", "BoothNumber": "100", "Comment": "Booth Rental", "DepositSlipId": "20170101", "ExhibitorId": "T0000001", "ExpocadUser": "ACT", "GlCode": "100-10001", "InvoiceDate": "2017-01-01T00:00:00", "InvoiceDateGenerated": "2016-02-01T00:00:00", "InvoiceDueDate": "2017-02-01T00:00:00", "InvoiceModified": false, "InvoiceNumber": "1001", "InvoiceTerms": "string", "InvoiceTotalDue": "500.00", "InvoiceTotalPaid": "500.00", "IsReversed": false, "PaymentAprNumber": "123456", "PaymentCardExpirationDate": "01/20", "PaymentCardNumber": "1111", "PaymentNote": "Paid by credit card", "PaymentType": "Credit Card", "PaymentTypeCategory": "P", "TransactionCode": "Space", "TransactionDateGenerated": "2016-01-01T06:30:30", "TransactionType": "FEE" }
Summary: Get a collection of all pavilions
Description: Returns a collection of all pavilions in the supplied event.
Syntax:
EXPOCAD.Pavilions_GetAllPavilions (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (Pavilion)
Summary: Add a new rate plan
Description: Adds a new rate plan to the supplied event.
Syntax:
EXPOCAD.RatePlans_AddRatePlan (string ClientName, string databaseName, RatePlan ratePlan)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
ratePlan |
|
|
True |
Returns:
Type:RatePlan
Default Value: { "FixedDiscountRate": 0, "GrossRate": 10, "IsFixed": false, "Name": "Base Plan", "PercentDiscountRate": 0, "ShortCode": "BASE" }
Summary: Get a collection of all rate plans
Description: Returns a collection of all rate plans in the supplied event.
Syntax:
EXPOCAD.RatePlans_GetAllRatePlans (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (RatePlan)
Summary: Get the currently set default rate plan
Description: Returns the currently set default rate plan from the supplied event.
Syntax:
EXPOCAD.RatePlans_GetDefaultRatePlan (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:RatePlan
Default Value: { "FixedDiscountRate": 0, "GrossRate": 10, "IsFixed": false, "Name": "Base Plan", "PercentDiscountRate": 0, "ShortCode": "BASE" }
Summary: Set the default rate plan
Description: Sets the default rate plan for the supplied event.
Syntax:
EXPOCAD.RatePlans_SetDefaultRatePlan (string ClientName, string databaseName, string name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
|
name |
string (name) |
The rate plan name. |
True |
Returns:
Type:RatePlans_SetDefaultRatePlanResponse
Summary: Get a collection of all showinshows
Description: Returns a collection of all showinshows in the supplied event.
Syntax:
EXPOCAD.ShowInShows_GetAllShowinShows (string ClientName, string databaseName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ClientName |
string (EXPOCAD Account) |
Organization Account use for EXPOCAD |
True |
|
databaseName |
string (databaseName) |
The database name of the EXPOCAD event. |
True |
Returns:
Type:array of (ShowInShow)
Summary:
Description:
Properties:
Name |
Type |
Summary |
Area |
string
|
|
BoothClasses |
array of (string)
|
|
BoothNumber |
string
|
|
BoothType |
string
|
|
ChildExhibitors |
array of (string)
|
|
Dimensions |
string
|
|
DisplayNameOverride |
string
|
|
ExhibitorId |
string
|
|
HoldComment |
string
|
|
HoldExhibitorId |
string
|
|
HoldExhibitorName |
string
|
|
IsDeleted |
boolean
|
|
IsOnHold |
boolean
|
|
IsRented |
boolean
|
|
OpenCorners |
integer(int32)
|
|
Pavilion |
string
|
|
ShowInShow |
string
|
|
Status |
string
|
|
UnitType |
string
|
|
XSize |
string
|
|
YSize |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Color |
integer(int32)
|
|
CountAsInventory |
integer(int32)
|
|
Description |
string
|
|
Id |
string
|
|
KeepWhenCombined |
integer(int32)
|
|
Name |
string
|
|
Prioritity |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
dDis_Value |
number(double)
|
|
dDiscount |
number(double)
|
|
dGross_Rate |
number(double)
|
|
dNet_Rate |
number(double)
|
|
dTotal_Due |
number(double)
|
|
dTotal_Ext |
number(double)
|
|
dUsf |
number(double)
|
|
szBooth |
string
|
|
szBoothStatus |
string
|
|
szComment |
string
|
|
szCommitDate |
string
|
|
szCustId |
string
|
|
szDepositDate |
string
|
|
szInvoice |
string
|
|
szRatePlan |
string
|
|
szReceivedDate |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AvailableBoothArea |
string
|
|
AvailableBoothPercentage |
string
|
|
AvailableBooths |
string
|
|
HoldBoothArea |
string
|
|
HoldBoothPercentage |
string
|
|
HoldBooths |
string
|
|
NetValueSold |
string
|
|
NonInventoryBoothArea |
string
|
|
NonInventoryBooths |
string
|
|
RentedBoothArea |
string
|
|
RentedBoothPercentage |
string
|
|
RentedBooths |
string
|
|
TotalBoothArea |
string
|
|
TotalBooths |
string
|
|
TotalExhibitors |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Address1 |
string
|
|
Address2 |
string
|
|
CellPhone |
string
|
|
City |
string
|
|
Comments |
string
|
|
Comments2 |
string
|
|
Contact |
string
|
|
Country |
string
|
|
DisplayOnDrawing |
string
|
|
DoingBusinessAs |
string
|
|
DoingBusinessAsDisplayOnDrawing |
string
|
|
|
string
|
|
ExhibitorId |
string
|
|
ExhibitorName |
string
|
|
ExhibitorNameLine2 |
string
|
|
Fax |
string
|
|
Field1 |
string
|
|
Field2 |
string
|
|
Field3 |
string
|
|
Field4 |
string
|
|
Field5 |
string
|
|
Field6 |
string
|
|
Field7 |
string
|
|
Field8 |
string
|
|
Field9 |
string
|
|
NickName |
string
|
|
Phone |
string
|
|
PostalCode |
string
|
|
PrimaryGroup |
string
|
|
PriorityPoints |
string
|
|
ProductDescription |
string
|
|
Salutation |
string
|
|
State |
string
|
|
Title |
string
|
|
WebSite |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
ContractorName |
string
|
Gets or sets the contractor name. |
ContractorPhone |
string
|
Gets or sets the contractor phone. |
DatabaseName |
string
|
Gets or sets the database name. |
EventDescription |
string
|
Gets or sets the event description. |
EventExhibitorFile |
string
|
Gets or sets the event exhibitor file. |
EventLocation |
string
|
Gets or sets the event location. |
EventLocation2 |
string
|
Gets or sets the event location 2. |
EventName |
string
|
Gets or sets the event name. |
ShowDates |
string
|
Gets or sets the show dates. |
ShowTitle |
string
|
Gets or sets the show title. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Amount |
number(double)
|
|
CCExpDate |
string
|
|
CCLast4 |
string
|
|
DepositId |
string
|
|
ExhibitorId |
string
|
|
InvoiceNumber |
string
|
|
Note |
string
|
|
PayRecId |
string
|
|
PaymentDate |
string(date-time)
|
|
PaymentType |
string
|
|
PaymentTypeCategory |
string
|
|
TransactionId |
string
|
|
User |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
BoothNumber |
string
|
|
Date |
string(date-time)
|
|
Description |
string
|
|
ExhibitorID |
string
|
|
GlCode |
string
|
|
InvoiceNumber |
string
|
|
LineTotal |
number(double)
|
|
Quantity |
integer(int32)
|
|
TransactionCode |
string
|
|
UnitCost |
number(double)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Description |
string
|
|
GlCode |
string
|
|
TransactionCode |
string
|
|
UnitCost |
number(double)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
PaymentType |
string
|
|
PaymentTypeCategory |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
FixedDiscountRate |
number(double)
|
|
GrossRate |
number(double)
|
|
IsFixed |
boolean
|
|
Name |
string
|
|
PercentDiscountRate |
number(double)
|
|
ShortCode |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Amount |
string
|
|
BoothNumber |
string
|
|
Comment |
string
|
|
DepositSlipId |
string
|
|
ExhibitorId |
string
|
|
ExpocadUser |
string
|
|
GlCode |
string
|
|
InvoiceDate |
string(date-time)
|
|
InvoiceDateGenerated |
string(date-time)
|
|
InvoiceDueDate |
string(date-time)
|
|
InvoiceModified |
boolean
|
|
InvoiceNumber |
string
|
|
InvoiceTerms |
string
|
|
InvoiceTotalDue |
string
|
|
InvoiceTotalPaid |
string
|
|
IsReversed |
boolean
|
|
PaymentAprNumber |
string
|
|
PaymentCardExpirationDate |
string
|
|
PaymentCardNumber |
string
|
|
PaymentNote |
string
|
|
PaymentType |
string
|
|
PaymentTypeCategory |
string
|
|
TransactionCode |
string
|
|
TransactionDateGenerated |
string(date-time)
|
|
TransactionType |
string
|
|