Skip to main navigation
Skip to main content
Studio/VE Documentation
Menu
RESTful API
Overview
External User API
Overview
OpCode I: Create a User
Opcode U: Update a User
Opcode C: Update a User, creating them if they do not exist
OpCode D: Delete a User
OpCode E: Check if User exists
OpCode G: Get User Profile information
OpCodes R and r: Register a User for a show with specified Show Package
OpCode Q: Unregister a User from a Show
OpCode Z: Get Registration Unique ID
OpCode K: Retrieve a User’s Registration Show Package information
OpCode A: Get User Registration Add-On information
OpCode F: Retrieve a list of available Shows
OpCode T: Create a Login Ticket for the specified User
OpCode V: Add Badges to the specified User
OpCode W: Set Badges for the specified User
OpCode O: Remove Badges from the specified User
OpCode Y: Retrieve a User’s Badge information
OpCode M: Add AddOn Items To The Registration For The Specified User
OpCode N: Remove AddOn Items from the Registration for the specified User
OpCode H: Retrieve a list of AttendeeTypes
OpCode J: Add an Attendee Type
OpCode @: Forget User (EU Compliance)
OpCode X: Retrieve the External API Failure Log
Passing UDF values
Passing Show Survey responses
Time Zone info key reference
Locale ID reference
Profile Country drop-down reference
External Registration Activity API
External Briefcase API
Overview
OpCode A: Add Attachment to User Briefcase
Opcode L: List Attachment from User Briefcase
Opcode R: Remove Attachment from User Briefcase
External Buddy List and Show Planner
Overview
Buddy List OpCode A: Add a User to the Buddy List
Buddy List OpCode D: Delete a User from the Buddy List
Buddy List Opcode L: List the Users in the Buddy List
Show Planner Opcode A: Add an item to the Show Planner
Show Planner OpCode D: Delete an Item from the Show Planner
Show Planner OpCode L: List items in the Show Planner
External Course Admin API
Overview
OpCode C: List Courses
OpCode L: List Attendee's Course Status
External Event API
Overview
Event Grouping OpCode EGL: List Event Groupings
Event Grouping OpCode EGI – Add A New Event Grouping
Event Grouping OpCode EGU: Update an Event Grouping
Event Grouping OpCode EGD: Delete an Event Grouping
Event Grouping OpCode EGC: Create or Update an Event Grouping
Event Speaker OpCode ESL: List Event Speakers
Event Speaker OpCode ESI: Add a New Event Speaker
Event Speaker OpCode ESU: Update an Event Speaker
Event Speaker OpCode ESD: Delete an Event Speaker
Event Speaker OpCode ESC: Create or Update an Event Speaker
Event Track OpCode ETL: List Event Tracks
Event Track OpCode ETI: Add a New Event Track
Event Track OpCode ETU: Update an Event Track
Event Track OpCode ETD: Delete An Event Track
Event Track OpCode ETC: Create or Update Event Track
Event Track OpCode ETM: List the Event Members for an Event Track
Event Track OpCode ETA: Add an Event as an Event Track
Event Track OpCode ETR: Remove an Event from an Event Track
Event Package OpCode ETX: List Event Track UDF Assignments
Event Moderators OpCode EML: List Moderator/Staffer for an Event
Event Moderators OpCode EMI: Add Moderator/Staffer to an Event
Event Moderators OpCode EMU: Update Moderator/Staffer for an Event
Event Moderators OpCode EMD: Delete Moderator/Staffer from an Event
Event Moderators OpCode EMC: Add or Update Moderator/Staffer to an Event
Event Dates OpCode EDL: List Dates for an Event
Event Dates OpCode EDI: Add Dates for an Event
Event Dates OpCode EDU: Updates Dates for an Event
Event Dates OpCode EDD: Delete Dates for an Event
Event OpCode EEL – List Events
Event OpCode EEI: Add an Event
Event OpCode EEU: Update an Event
Event OpCode EED: Delete an Event
Event OpCode EEC: Create or Update an Event
Event OpCode ETX – Retrieve Event Extra Data (UDF values)
Event Attachment OpCode EAI: Add an Attachments to an Event
Event Attachment OpCode EAL: List Attachments for an Event
Event Attachment OpCode EAU: Update an Attachments to an Event
Event Attachment OpCode EAD: Delete an Attachment from an Event
Event Attachment OpCode EAC: Create or Update an Attachment to an Event
Event Question and Answer List OpCode EQL: List Q&A for an Event
Subject Category OpCode SCL: List Subject Categories
Subject Category OpCode SCI – Add A New Subject Category
Event Providers OpCode EPL – List Valid Event Providers
Categories OpCode CTL: List Valid Categories
Event Attendee Visit OpCode EVA – Add An Attendee Visit For An Event
Presentation Role Macros OpCode ERL: List Defined Role Macros
Appendix A: Language Alternates
Appendix B: Param Block Layout
External Exhibitors and Booths API
Overview
Exhibitor OpCode EI: Add New Exhibitor
Exhibitor OpCode EU: Update An Exhibitor
Exhibitor OpCode EC: Add Or Update An Exhibitor
Exhibitor OpCode EL: List Users For An Exhibitor
Exhibitor OpCode ER: Retrieve Exhibitor Information
Exhibitor Informational Helper OpCode ET: List Exhibitor Types
Exhibitor Informational Helper OpCode ES: List Exhibitor Statuses
Booth OpCode BI: Add New Booth
Booth OpCode BU: Update A Booth
Booth OpCode BC: Add Or Update A Booth
Booth OpCode BR: Retrieve Booth Information
Booth Documents/Links OpCode DL: List Booth Documents/Links
Booth Documents/Links OpCode DI: Insert Booth Document/Link
Booth Documents/Links OpCode DU: Update Booth Document/Link
Booth Documents/Links OpCode DD: Delete Booth Document/Link
Booth Documents/Links OpCode DC: Create or Update Booth Document/Link
Booth Informational Helper OpCode BL: List Booth Layouts
Booth Informational Helper OpCode BT: List Booth Types
Booth Informational Helper OpCode BX: List Booth Templates
Booth Staffer OpCode SL: List Booth Staffers
Booth Staffer OpCode SI: Add Staffer To A Booth
Booth Staffer OpCode SU: Update A Booth Staffer
Booth Staffer OpCode SD: Delete A Staffer From A Booth
Booth Staffer OpCode SC: Create Or Update A Booth Staffer
External Jobs API
Overview
Job Category Opcode JCL: List Job Categories
Job Category Opcode JCI: Add a New Job Category
Job Category Opcode JCU:Update a New Job Category
Job Category Opcode JCD: Delete a Job Category
Job Category Opcode JCC: Create or Update a Job Category
Job Posting Opcode JPL: List Job Postings
Job Category Opcode JPI: Add a New Job Posting
Job Posting Opcode JPU: Update a Job Posting
Job Posting Opcode JPI: Delete a Job Posting
Job Posting Opcode JPC: Create or Update a Job Posting
Job Posting Opcode JPA: Retrieve Applicant Information for Job Posting
Job Posting Opcode JPV: Retrieve Views Information for Job Posting
External Show Setup API
Overview
AddOnItem Node
Affiliate Node
BannerAd Node
Booth Node
BoothBuilderDate Node
BoothBuilderLimit Node
BoothGiveaway Node
BoothUDF Node
ChatRoom Node
ContentInterestCategory Node
DocLink Node
Event Node
EventSurvey Node
ExhibitorUDF Node
Language Node
MarqueeMessage Node
RegistrationPage Node
SecurityGroup Node
SecurityGroupChannelAssignment Node
SecurityGroupProgramAssignment Node
Show Date Node
Show Node
Show Package Node
ShowExhibitor Node
ShowFeature Node
ShowGiveaway Node
ShowSurvey Node
SubjectCategory Node
UserUDF Node
Appendix A: Sample XML Output
External Show User Activity API
Overview
AnnouncementActivity Node
Badge Award Node
BannerAdClick Node
BlogPost Node
BlogPostComment Node
BlogPostView Node
BoothRating Node
BoothTabVisit Node
BoothVisit Node
ChatRoomVisit Node
Communication Center Recap Node
Course Certificates Node
Course Test Summary Node
DataPortalLogin Node
DocLinkActivity Node
EventRating Node
Event Survey Response Node
EventVisit Node
ExhibitorProfileView Node
ForgotPassword Node
GamePlay Node
GiveawayEntry Node
InviteUser Node
JobApplication Node
JobView Node
Media Download Node
Presentation Attendance Verification Node
Presentation Evite Responses Node
Presentation Question Node
Private Chats Engaged Node
Private Chats Missed Node
Show Survey Response Node
ShowFloorVisit Node
ShowLogin Node
ShowSearch Node
ShowUser Node
ShowUserActivity Node
Social Media Activity Node
UserMatching Node
Appendix A: Sample XML output
External User Studio Show Registration API
Overview
Show Node
External Webcast Show Create/Copy API
Overview
PRIME Webcast Show Creation OpCode C: Create or Copy a new PRIME Webcast
External SSO Deep Link Get Exhibitor API
UDF API
Overview
OpCode UDC: Update a UDF Definition, Creating it if it does not already exist
OpCode UDD: Delete a UDF Definition
OpCode UDI: Create a UDF Definition
OpCode UDL: List UDF Definitions
OpCode UDU: Update a UDF Definition
OpCode UGC: Update A UDF Group, Creating it if it does not exist
OpCode UGD: Delete A UDF Group
OpCode UGI: Create A UDF Group
OpCode UGU: Update A UDF Group
OpCode UPC: Update A UDF Pick List/MultiSelect List, Creating one if it does not exist
OpCode UPD: Delete A UDF Pick List/MultiSelect List
OpCode UPI: Create A UDF Pick List/MultiSelect List
OpCode UPL: List UDF Definition
OpCode UPU: Update A UDF Pick List/MultiSelect List
OpCode USV: UDF Source Values Listing
OpCode UVL: List UDF Values
OpCode UVM: Save UDF Multiple Values
OpCode UVS: Save UDF Values
Studio Accessibility
Overview
Color
Graphics
Texts and Fonts
Social Profile
365 Event
Space Builder Guide
Overview
About Us
Documents and Links
Format and Requirements
Marquee Messaging
Scheduled Breakout Rooms
Search Words
Space Colors
Space Front Screen
Space Logo
Space Staff
Space Styles
Space Tab Content
Sponsor Space Name
Video Collection