xpobay.com (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@xpobay.com URL: https://xpobay.com/contact/ Terms of Service

Events

Events Operations.

List of Events

Retrieve a list of events.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  https://my.xpobay.com/api/events \
  -H 'x-access-token: string'

Response samples

200
401

Content type

application/json

{"success": true,
"events": [{"name": "Covactination Camp",
"id": 269,
"is_event_with_stands": 1
}
],
"paging": {"page": 1,
"current": 1,
"pageCount": 1,
"nextPage": false,
"prevPage": false,
"count": 1,
"perPage": 20
}
}

List of User Categories

Retrieve a list of user categories for an event.

query Parameters

event_id

required

integer

Example: event_id=269

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/events/user_categories?event_id=269' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"user_categories": [{"id": 833,
"name": "Shell Scheme",
"description": null
}
]
}

Add User Category

Add a new user category to an event.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
name	string

Responses

Request samples

Content type

application/json

{"event_id": 269,
"name": "test user category"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "User category added successfully."
}

List of User Types

Retrieve a list of user types for an event.

query Parameters

event_id

required

integer

Example: event_id=269

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/events/user_types?event_id=269' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"user_types": [{"id": 1475,
"name": "Default",
"description": null
}
]
}

Add User Type

Add a new user type to an event.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
name	string

Responses

Request samples

Content type

application/json

{"event_id": 269,
"name": "test1 user type"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "User type added successfully."
}

List of Event Locations

Retrieve a list of event locations for an event.

query Parameters

event_id

required

integer

Example: event_id=269

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/events/locations?event_id=269' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"event_locations": [{"id": 167,
"name": "test location",
"description": ""
}
]
}

Add Event Location

Add a new event location.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
name	string

Responses

Request samples

Content type

application/json

{"event_id": 269,
"name": "Jaipur"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "Event location added successfully."
}

List of Event Dimensions

Retrieve a list of event dimensions for an event.

query Parameters

event_id

required

integer

Example: event_id=269

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/events/dimensions?event_id=269' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"event_dimensions": [{"id": 1951,
"name": "200x200",
"description": ""
}
]
}

Add Event Dimension

Add a new event dimension.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
name	string

Responses

Request samples

Content type

application/json

{"event_id": 269,
"name": "5 X 4"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "Event Dimension added successfully."
}

Users

Users Operations.

List of Users

Retrieve a list of users with optional pagination.

query Parameters

page	integer >= 1 Example: page=1 Page number for pagination (optional)
event_id required	integer Example: event_id=269

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/users?page=1&event_id=269' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"users": [{"firstname": "test",
"lastname": "test123",
"email": "test@gmail.com",
"company_name": "Enteract",
"mobile_number": 9928621044,
"telephone_number": "",
"street": "12 test Street",
"city": "test",
"state": "vic",
"postcode": 2525,
"country": "AF",
"user_categories": "Shell Scheme",
"stand_dimension": null,
"stand_location": null,
"stand_number": "TBC103",
"stand_name": "Test",
"preferred_language": "",
"user_types": "EBTS Brisbane 2017",
"user_id": 206,
"uid": 0,
"event_id": 269
}
]
}

Add User

Add a new user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

firstname	string
lastname	string
email	string
company_name	string
contact_mobile_number	string
contact_telephone_number	string
external_username	string
external_password	string
street	string
city	string
state	string
postcode	string
country	string
event_id	integer
user_types	string
preferred_language	string
stand_name	string
stand_number	string
stand_location_id	integer
stand_dimension_id	integer
user_category_id	string

Responses

Request samples

Content type

application/json

{"firstname": "John",
"lastname": "Smith",
"email": "xyz@xyzre.com",
"company_name": "company",
"contact_mobile_number": "9928621044",
"contact_telephone_number": "9928621044",
"external_username": "username",
"external_password": "Passw0rd!",
"street": "street",
"city": "city",
"state": "state",
"postcode": "postcode",
"country": "country",
"event_id": 269,
"user_types": "1475,1476",
"preferred_language": "english",
"stand_name": "booth",
"stand_number": "2525",
"stand_location_id": 167,
"stand_dimension_id": 1951,
"user_category_id": "833,834"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "User added successfully.",
"user_id": 9066,
"uid": "2699066"
}

Edit User

Edit an existing user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

firstname	string
lastname	string
email	string
company_name	string
contact_mobile_number	string
contact_telephone_number	string
external_username	string
external_password	string
street	string
city	string
state	string
postcode	string
country	string
event_id	integer
user_types	string
preferred_language	string
stand_name	string
stand_number	string
stand_location_id	integer
stand_dimension_id	integer
user_category_id	string
user_id	integer
reg_id	integer

Responses

Request samples

Content type

application/json

{"firstname": "John",
"lastname": "Smith",
"email": "xyz@xyzre.com",
"company_name": "company",
"contact_mobile_number": "9928621044",
"contact_telephone_number": "9928621044",
"external_username": "username",
"external_password": "Passw0rd!",
"street": "street",
"city": "city",
"state": "state",
"postcode": "postcode",
"country": "country",
"event_id": 269,
"user_types": "1475,1476",
"preferred_language": "english",
"stand_name": "booth",
"stand_number": "2525",
"stand_location_id": 167,
"stand_dimension_id": 1951,
"user_category_id": "833,834",
"user_id": 9066,
"reg_id": 50883
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "User updated successfully.",
"user_id": "9066",
"uid": "2699066"
}

Details of User

Retrieve details of a specific user.

query Parameters

event_id required	integer Example: event_id=269
user_id required	integer Example: user_id=9066
reg_id required	integer Example: reg_id=2699066

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Responses

Request samples

curl
Node.js
JavaScript
PHP
Python

curl -i -X GET \
  'https://my.xpobay.com/api/users/user_detail?event_id=269&user_id=9066&reg_id=2699066' \
  -H 'x-access-token: string'

Response samples

200
400
401

Content type

application/json

{"success": true,
"user_detail": {"firstname": "John",
"lastname": "Smith",
"email": "xyz@xyzre.com",
"company_name": "company",
"mobile_number": "9928621044",
"telephone_number": "9928621044",
"street": "street",
"city": "city",
"state": "state",
"postcode": "postcode",
"country": "COUNTRY",
"stand_number": "2525",
"stand_name": "booth",
"stand_location": "test location",
"stand_dimension": "200x200",
"user_categories": "Shell Scheme | Space Only",
"preferred_language": "english",
"user_types": "Default | EBTS Brisbane 2017",
"user_id": 9066,
"uid": "2699066",
"event_id": 269,
"custom_fields": [null
]
}
}

Delete User

Delete a specific user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
user_id	integer
reg_id	integer

Responses

Request samples

Content type

application/json

{"event_id": 269,
"user_id": 9066,
"reg_id": 50883
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "User deleted successfully."
}

Update Custom Field of User

Update a custom field of a specific user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
user_id	integer
field_id	integer
field_value	string
reg_id	integer

Responses

Request samples

Content type

application/json

{"event_id": 269,
"user_id": 9067,
"field_id": 24305,
"field_value": "123456789",
"reg_id": 50883
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "Record updated successfully."
}

Delete Custom Field of User

Delete a custom field of a specific user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
user_id	integer
field_key	string
reg_id	integer

Responses

Request samples

Content type

application/json

{"event_id": 269,
"user_id": 9067,
"field_key": "Label",
"reg_id": 50883
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "Record deleted successfully."
}

Send Welcome Email to User

Send a welcome email to a specific user.

header Parameters

x-access-token

required

string <Bearer>

Access token for authentication

Request Body schema: application/json

event_id	integer
user_id	integer
reg_id	integer

Responses

Request samples

Content type

application/json

{"event_id": 269,
"user_id": 9067,
"reg_id": 50883
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "Welcome email sent successfully."
}

Login

Request Body schema: application/json

email	string <email>
password	string

Responses

Request samples

Content type

application/json

{"email": "xx@xx.com",
"password": 123456
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJteWFwcCIsInN1YiI6MjA5LCJleHAiOjE2MzE4NTg4NTN9.qmUcIjyFkj8GSkdcMuPOcSx5XjjFd89ZYAcSL9fItdlDVmLu_kkZegbJm_QK0_Kls_tB3MTJ2v5nACIlooh0QztKA54JJT9oPlqIcJgwNpuqcQkrOdBoNA7gx82CqnBaxo7ajpqpwMoU02PCT8bHw-E5ZJCc2vWIp9lFvFpxlwo"
}
}