API Requests

Events list

Using this request you can receive list of events

/app/getexhibitions

GET

Response example:

"exhibitions": [
    {
		"id": 115,
		"title": "Event 1",
		"start": 1492732800,
		"end": 1492905600,
		"country": "New Zealand",
		"city": "Christchurch",
		"address": "Wellington ave",
		"venue": "Venue name",
		"place_id": 48,
		"analytics_db": "event_1_analytics_db",
		"backend": "https://{{ your_client}}.expoplatform.com",
		"frontend": "{{ your_client_domain }}",
		"location": "Event 1 Location"
	},
	{
		"id": 116,
		"title": "INTERNATIONAL BUSINESS FESTIVAL 2018",
		"start": 1543708800,
		"end": 1543795200,
		"country": "United Kingdom",
		"city": "London",
		"address": "One Western Gateway E16 1XL",
		"venue": "ExCeL London",
		"place_id": 49,
		"analytics_db": "event_2_analytics_db",
		"backend": "https://{{ your_client }}.expoplatform.com",
		"frontend": "{{ your_client_domain }}",
		"location": "Event 2 Location"
	},
}

Visitors list

Using this request you can receive list of visitors

/visitors?getSynchronise=true

GET

Request params:

event_id	Event (Exhibition) ID
timestamp	The time point after which the changes were made (in UNIX time() format. Ex. 1512345678). Send timestamp=0 if you need get all visitor data.

Optional paramets (to receive visitors emails in response body):

id	Admin ID
token	Admin access token

Request example:

/visitors?getSynchronise=true&event_id=7&timestamp=1512345678

Response example:

"created": {
	"visitors": [
	    {
		"id": 20009,
		"gender": "Mr.",
		"first_name": "Jack",
		"last_name": "Smith",
		"company": "NickSystems",
		"country": "United Kingdom",
		"city": "London",
		"address": "Backer street",
		"position": "Director",
		"organisationName": "OrganisationName",
		"organisationId": "TYSD2443KSS",
		"code": 244369532650,
		"ext_barcode": null,
		"exhibitor_id": 0,
		"phone": "+44324324",
		"email": "jacks@nickss.com",
		"web": "www.nickss.com",
		"badge_id": 1
	    },
},
"updated": {
	"visitors": [
	    {
		"id": 20009,
		"gender": "Mrs.",
		"first_name": "Mary",
		"last_name": "Hollis",
		"company": "Strategy Group",
		"country": "United Kingdom",
		"city": "London",
		"address": "Holter Street, 4",
		"position": "Manager",
		"organisationName": "OrganisationName",
		"organisationId": "TYSD2443KSS",
		"code": 244369532650,
		"ext_barcode": null,
		"exhibitor_id": 0,
		"phone": "+44324324",
		"email": "mary@bstrategy-group.com",
		"web": "www.stsgts.com",
		"badge_id": 1
	    },
},
"deleted": {
	"visitors": [20218, 20219, 20233],
},

Synchronize data

Using this request you can receive list of exhibitors, sessions, sponsors, relations, static pages and other info

/connect?getSynchronise=true

GET

Request params:

event_id*	Event (Exhibition) ID
timestamp*	The time point after which the changes were made (in UNIX time() format. Ex. 1512345678). Send timestamp=0 if you want get all data.

Request example:

/connect?getSynchronise=true&event_id=7&timestamp=1512345678

Response example:

"created": {
	"exhibitor": [{
		"id": 732,
		"admin_in": "1333",
		"company": "Imperial Industries / Right Industries",
		"country": "India",
		"city": "Mumbai",
		"description": "Exhibitor full description",
		"website": "www.imperialindustries.in",
		"stand_id": 237,
		"external_id": "12323434"
	}],
	"stand": [{
		"id": 1352,
		"hall_id": 19,
		"exhibitor_id": 1516,
		"title": "7D160",
		"coord": "[[1458.6768802228414,385.3788300835655],[1631.557103064067,385.3788300835655],[1631.557103064067,558.2590529247911],[1458.6768802228414,558.2590529247911]]"
	}],
	"hall": [{
		"id": 19,
		"name": "Hall 2",
		"url": "/image/MTQxOTkyNjAxNTU0YTI1OWZmOTVjYTM=.png",
		"coord": "[[547.4324512534819,306.44707520891365],[823.6664345403899,306.44707520891365],[823.6664345403899,540.958217270195],[545.9937325905292,542.3969359331476]]"
	}],
	"product": [{
		"id": 215,
		"exhibitor_id": 1132,
		"name": "Shital Industries Pvt. Ltd.",
		"description": "Product detail description"
	}],
	"category": [{
		"id": 577,
		"name": "Semi finished products of polycarbonate (PC)",
		"parent_id": 573
	}],
	"visitor_categories": [{
		"id": 577,
		"title": "VIP Visitors"
	}],
	"exhibitor_category_relation": [{
		"id": 4818,
		"exhibitor_id": 1657,
		"category_id": 83
	}],
	"product_category_relation": [{
		"id": 42,
		"product_id": 375,
		"category_id": 24
	}],
	"event_category": [{
		"id": 1,
		"title": "Category name",
		"description": null
	}],
	"event": [{
		"id": 23,
		"start": 1543757400,
		"end": 1543764600,
		"title": "De-Inking and Paint Removal Technology",
		"description": "Session description",
		"event_category_id": 1,
		"exhibitor_id": 0,
		"location": "Conference Hall №3",
		"hall_id": "36",
		"moderators": [
		  "18599"
		],
		"sponsors": [
		  "46",
		  "5"
		],
	}],
	"sponsors": [{
		"id": 46,
		"title": "Sponsor Gold",
		"website": "www.gsgss.com",
		"exhibitor_id": null,
		"is_partner": false,
		"enabled": false
	}],
	"event_speaker_relation": [{
		"id": 1612,
		"speaker_id": 18625,
		"event_id": 29
	}],
	"content_images": [{
		"id": 1882,
		"url": "/image/MTQyMTMxMzM5NDU0Yjc4NTcyNzFmNDM=.jpeg",
		"format": "png",
		"title": "Prasad Group: Logo"
	}],
	"content_media": [{
		"id": 1113,
		"url": "/file/MTQ5MjA5NDk5MjU4ZWY5MDEwMWFlYjk=.phpBczhsy",
		"format": "text/plain",
		"title": "New File.txt"
	}],
},

"updated": { The same structure },
"deleted": { IDs of deleted element},
"synchronisation_time_stamp": 1502107852

User Data

Using this request you can receive visitor profile information after signin

/appuserdata

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Event (Exhibition) ID
timestamp*	The time point after which the changes were made (in UNIX time() format. Ex. 1512345678). Send timestamp=0 if you want get all data.

Request example:

/appuserdata?id=12533&token=jsgfdjgsdlkgsdjklw43229ufjesfjsdfs&event_id=7&timestamp=1512345678

Response example:

"created": {
	"connection": [
	  "2000",
	  "18650"
	],
	"message": [{
		"id": "10678",
		"sender_id": "18625",
		"receiver_id": "18576",
		"subject": "Message subject",
		"body": "This is body of message",
		"timestamp": "1494420060",
		"is_read": 1,
		"is_favorite": 0
	}],
	"meetings": [{
		"id": 362,
		"host": 18625,
		"guest": 1127,
		"subject": "VeriFair",
		"description": "Metting Description",
		"location": "Meeting room 1",
		"start": 1449154800,
		"end": 1449158400,
		"status": "pending",
		"hosts": null,
		"guests": [
		  18136,
		  18139
		],
	}],
	"favorite_products": [
		"939",
		"799"
	],
	"favorite_event": [
	  	3,
	  	9,
	],
	"scans": [{
		"id": 93,
		"account_id": 18625,
		"time": 1496158736,
		"hot": 0,
		"statusNew": 0,
		"notes": null,
		"contacted": 0,
		"category": 0
	}],
	"notifications": [{
		"id": "5573",
		"owner_id": "18625",
		"creator_id": "1752",
		"text": "Exhibitor 1 has confirmed an appointment at 2015-12-03 11:15 regarding “Appointment request 1” between You and Exhibitor 1.",
		"notifications_type": 7,
		"isRead": 0,
		"time": "1501662924",
		"info": "489",
		"notification_name": "app_confirm_request"
	}],
	"briefcase_image": [
	  	3904,
	  	3905
	],
	"briefcase_media": [
		1015,
		938
	],
	"notification_type": [{
		"id": 7,
		"type": "app_confirm_request"
	}],
},
"updated: { The same structure },
"deleted: { IDs of deleted element },
"timestamp: 1502111365,

Accounts

Get Account Info

Use this request to get account info

/api/account/get

GET

Request params:

id*	INT	Account ID
event_id*	INT	Exhibition ID

Exhibitors

Get Exhibitor Info

Use this request to get exhibitor info

/api/exhibitor/get

GET

Request params:

id*	INT	Exhibitor ID
event_id*	INT	Exhibition ID

Create (Update) Exhibitor

Use this request to create new or update exist exhibitor

/registration/exhibitor

POST

Request params:

event_id*	Exhibition ID
name	Exhibitor name
email	Exhibitor email. Required field for create new Exhibitor
exhibitor_id	Exhibitor internal ID (set this field for update Exhibitor profile by ID)
external_id	Exhibitor external ID (set this field for update Exhibitor profile by external ID)
username	Exhibitor username (set this to an alphanumeric value if you want to set the username to something other than the exhibitor email. Leaving this empty will set the username to the email passed into email)
password	Exhibitor owner account password
short_name	Exhibitor short name
fascia_name	Exhibitor fascia name
country	Exhibitor country (name or ISO)
city	Exhibitor city (name or city ID)
zip	Exhibitor zip code
address	Exhibitor address
emails	Exhibitor additional emails (separated by comma)
phone	Main exhibitor phone
phones	Exhibitor additional phones (separated by comma)
fax	Exhibitor fax
about	Exhibitor at a glance information
website	Exhibitor website
legal_name	Exhibitor legal name
invoice_address	Exhibitor invoice address
vat	Exhibitor vat number
email_invoice	Exhibitor email to send invoice
category_id	Exhibitor category ID
cp_title	Exhibitor contact person title
cp_name	Exhibitor contact person name
cp_surname	Exhibitor contact person surname
cp_position	Exhibitor contact person position
cp_email	Exhibitor contact person email
hall	Exhibitor hall name
stand	Exhibitor stand name
acc_fb	Exhibitor facebook account (URL)
acc_in	Exhibitor linkedin account (URL)
acc_tw	Exhibitor twitter account (URL)
acc_yt	Exhibitor youtube account (URL)
acc_ig	Exhibitor instagram account (URL)
is_new	(bool) Set if exhibitor is new
logo	Exhibitor Logo file
default_lang	Default notifications language (ISO code)
send_email	true | false (default). Set true to send registration email
tags	Array of tag names

Remove Exhibitor from Event

Use this request to remove exhibitor from some event

/api/exhibitor/removeFromEvent

POST

Request params:

event_id*	Exhibition ID
id**	Exhibitor ID
external_id**	Exhibitor external ID

Add product categories to exhibitor

Use this request to attach product categories to exhibitor

/api/exhibitor/category

GET

Request params:

exhibitor_id*	Exhibitor ID
categories*	Product Categories ID (separated by comma)
event_id*	Event ID

Remove product categories from exhibitor

Use this request to remove product categories from exhibitor

/api/exhibitor/category/delete

DELETE

Request params:

exhibitor_id*	INT	Exhibitor ID
event_id*	INT	Event ID
category_id*	INT	Product Category ID

Attach Team Member

Use this request to attach team member to exhibitor

/api/exhibitor/addmember

POST

Request params:

account_id*	Team Member Account ID
exhibitor_id*	Exhibitor ID
event_id*	Event ID

Change External ID

Use this request to update external ID

/api/account/changeExternal

POST

Request params:

account_id*	Exhibitor Owner Account ID
external_id*	External ID
event_id*	Event ID

Categories

Get Product Categories

Use this request to get all categories from event

/api/category/list

GET

Request params:

event_id*

Event ID

Add Product Category

Use this request to create new category

/api/category/add

GET

Request params:

category_name*	Category Name
event_id*	Event ID
parent_id	Parent category ID

Messages

Send message

Use this request to send a message from a user to another user

/sendmessage

POST

Request params:

id*	Account ID
to*	Account ID of the message recipient
token*	Access Token
event_id*	Event (Exhibition) ID
title*	Message subject
message*	Message body
timestamp	The time point in UNIX time format when message was sent.

Opened message

Use this request when user opened message in profile

/profileapp?is_read=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Event (Exhibition) ID
message_id*	Message ID

Delete message

Use this request when to delete message in user profile

/profileapp?delete_message=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Event (Exhibition) ID
message_id*	Message ID

Appointments

Send appointment request

Use this request when to send an appointment request from user

/makeAppointment

POST

Request params:

id*	Account ID
token*	Access Token
reciever_id*	Reciever Account ID
event_id*	Event (Exhibition) ID
subject*	Appointment subject
description*	Appointment description
time*	The time point in UNIX time format when appointment will be starting
duration*	Appointment duration in minutes
location	Appointment location
location_name	If location = "other" please input custom location name
persons	Array of initiator account ids
meet_persons	Array of reciever account ids

Reschedule appointment request

Use this request to request an appointment to be rescheduled

/editAppointment

POST

Request params:

id*	Account ID
token*	Access Token
apid*	Appointment ID
event_id*	Event (Exhibition) ID
reschedule_reason*	Reschedule Reason
time*	The time point in UNIX time format when appointment will be starting
duration*	Appointment duration in minutes
location	Appointment location
location_name	If location = "other" please input custom location name
persons	Array of initiator account ids
meet_persons	Array of reciever account ids

Cancel appointment request

Use this to cancel an appointment

/cancelAppointment

POST

Request params:

id*	Account ID
token*	Access Token
apid*	Appointment ID
event_id*	Event (Exhibition) ID
reason	Cancel Reason

Confirm appointment request

Use this request to confirm an appointment

/confirmAppointment

POST

Request params:

id*	Account ID
token*	Access Token
apid*	Appointment ID
event_id*	Event (Exhibition) ID

Sessions

Get sessions list

Use this request to get session list

/api/session/list

GET

Request params:

event_id*

INT

Event ID

Get bought sessions list

Use this request to get bought sessions list

/api/session/list/bought

GET

Request params:

event_id*

INT

Event ID

Add session to shedule

Use this request to add session to user's shedule

/profileappnew?add_account_event=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Session ID

Delete session from shedule

Use this request to delete a session from user's shedule

/profileappnew?delete_account_event=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Session ID

Connections

Add visitor to connections

Use this request to add other visitor to user's connections

/profileapp?add_connection=true

GET

Request params:

id*	Account ID
token*	Access Token
connection_user_id*	Account ID which to connect

Add exhibitor to connections

Use this request to add exhibitor to user's connections

/profileapp?add_connection_exhibitor=true

GET

Request params:

id*	Account ID
token*	Access Token
connection_exhibitor_id*	Exhibitor ID which to connect

Delete visitor\exhibitor from connections

Use this request to remove user\exhibitor from user's connections

/profileapp?delete_connection=true

GET

Request params:

id*	Account ID
token*	Access Token
to_account_id*	Account ID or Exhibitor ID to delete from connections

Briefcase

Add file to briefcase

Use this request to add file to user's briefcase

/profileappnew?add_briefcase=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Event (Exhibition) ID
file_type*	Type of media. "media" or "image"
file_id*	Media ID

Delete file from briefcase

Use this request to delete file from user's briefcase

/profileappnew?del_from_briefcase=true

GET

Request params:

id*	Account ID
token*	Access Token
event_id*	Event (Exhibition) ID
file_type*	Type of media. "media" or "image"
file_id*	Media ID

Products

Add product

Use this request to add product

/api/product/add

POST

Request params:

name*	Product Name
categories*	Product Categories (separated by comma)
event_id*	Event ID
exhibitor_id*	Exhibitor ID
images[]	Array of Product Images
description	Product Description
launch	Set TRUE if you want to set launch tag for product

Update product

Use this request to update product

/api/product/update

POST

Request params:

product_id*	INT	Product Id
event_id*	INT	Event ID
name	STRING	Product Name
categories	STRING	Product Categories (separated by comma)
update_images	BOOL	Set TRUE if you want to remove old images from product
images[]	FILE	Array of Product Images
description	STRING	Product Description
launch	BOOL	Set TRUE if you want to set launch tag for product

Add product to favorites

Use this request to add product to user's favourites

/profileappnew?add_to_favorite_product=true

GET

Request params:

id*	Account ID
token*	Access Token
product_id*	Product ID

Delete product from favorites

Use this request to delete product from user's favoruites

/profileappnew?del_from_favorite_product=true

GET

Request params:

id*	Account ID
token*	Access Token
product_id*	Product ID

Get Products Database

Use this request to get products databse from all events

/api/product/database

GET

Delete Product

Use this request to delete product from DB or detach from event

/api/product/delete

DELETE

Request params:

product_id*	INT	Product ID
globally	BOOLEAN	Set TRUE if you want delete product from DB globally
event_id	INT	Set Event ID if you want detach product from event

Agents

Get Agents List

Use this request to get agents list

/api/agents/getList

GET

Request params:

event_id*

Event ID

Brands

New Brand

Use this request to create new brand for exhibitor

/api/exhibitor/brand/add

POST

Request params:

name*	Brand Name
description	Brand Description
website	Brand Website
exhibitor_id*	Exhibitor ID
event_id*	Event ID
image	Brand Image File (The user interfaces require square images to be uploaded (1:1 width to height ratio))

Update Brand

Use this request to update brand

/api/exhibitor/brand/update

POST

Request params:

brand_id	INT	Brand ID
name	STRING	Brand Name
description	STRING	Brand Description
website	STRING	Brand Website
exhibitor_id	INT	Exhibitor ID
event_id*	INT	Event ID
image	FILE	Brand Image File (The user interfaces require square images to be uploaded (1:1 width to height ratio))

Get Brands List

Use this request to get all brands

/api/brands

GET

Attach exhibitor brand to event

Use this request to attach some exhibitor brand to event

/api/exhibitor/addbrand

GET

Request params:

exhibitor_id*	Exhibitor ID
event_id*	Event ID
brand_id*	Brand ID

Attach brand to exhibitor

Use this request to attach some brand to ehibitor

/api/exhibitor/brand/attach

POST

Request params:

exhibitor_id*	INT	Exhibitor ID
event_id*	INT	Event ID
brand_id*	INT	Brand ID

Attach brand to product

Use this request to attach some exhibitor brand to product

/api/exhibitor/product/addbrand

GET

Request params:

exhibitor_id*	Exhibitor ID
event_id*	Event ID
brand_id*	Brand ID
product_id*	Product ID

Add Product Category to Brand

Use this request to attach some product category to brand

/api/brand/category/add

GET

Request params:

category_id*	Category ID
event_id*	Event ID
brand_id*	Brand ID

Remove Product Category from Brand

Use this request to remove some product category from brand

/api/brand/category/remove

DELETE

Request params:

category_id*	Category ID
event_id*	Event ID
brand_id*	Brand ID

Remove brand

Use this request to remove some exhibitor brand from event or remove globally

/api/exhibitor/removebrand

GET

Request params:

exhibitor_id*	Exhibitor ID
event_id*	Event ID
brand_id*	Brand ID
global	0 or 1 (0 - remove from event. 1 - global remove from DB). Default: 0

Remove brand from product

Use this request to remove some brand from product

/api/exhibitor/product/removebrand

GET

Request params:

product_id*

Product ID

Scan Badges

Exhibitor Team Member lead capture badge scans

Use this request for exhibitor team member lead capture badge scans

/profileappnew?badge_scan=true

GET

Request params:

id*	Account ID
token*	Access Token
scan_id*	Scanned Account ID
team_member_id*	Team Member ID
time	Time in UNIX format where badge was scanned
event_id*	Event (Exhibition) ID
notes	Notes to scan
cid	Category ID
new	1 or 0 (Yes or no)
contacted	1 or 0 (Yes or no)
rate	Rate (From 1 to 5)

Visitor lead capture badge scans

Use this request for visitor lead capture badge scans

/profileappnew?add_account_scan=true

GET

Request params:

id*	Account ID
token*	Access Token
account_id*	Scanned Account ID
time	Time in UNIX format where badge was scanned
event_id*	Event (Exhibition) ID
cid	Category ID
is_new	1 or 0 (Yes or no)
rate	Rate (From 1 to 5)

Delete scanned badge

Use this request to delete user's scanned visitor badge

/profileappnew?delete_account_scan=true

GET

Request params:

id*	Account ID
token*	Access Token
scan_id*	Scan ID

Countries and Cities

Get Countries List

Use this request to get all countries from DB

/getcountries

GET

Get Cities List

Use this request to get all cities in selected country from DB

/getcities

GET

Request params:

country_id*

Country ID

Titles

Use this request to get all titles from platform

/getTitles

GET

Request params:

event_id*

Event (Exhibition) ID

Request example:

/getTitles?event_id=7

Response example:

"Mr.", "Mrs.", "Miss", "Dr."

Social settings

Use this request to get social settings from platform

/social

GET

Request params:

event_id*

Event (Exhibition) ID

Request example:

/social?event_id=7

Response example:

"facebook": "ExpoPlatform, /1589245207975161, Expo2015Milano",
"twitter": "ExpoPlatform, Expo2015, Expo2015Milano, #visitExpo",
"pinterest": "operugini12",
"youtube1": "ExpoPlatform",
"youtube2": "expomilanotv",
"youtube3": "",
"youtube4": "",
"youtube5": ""

Images

Use this request to get image

/app/image

GET

Request params:

model*	visitor | exhibitor | speaker | event | sponsor
id*	ID field of any items
size*	Any size image format WIDTHxHEIGHT (for example 140х140 or 140х0)
circle	Overlay circular mask on the image. Can be 0 or 1.

Request example:

/app/image/?model=exhibitor&id=680&size=240x160&circle=0