Root endpoint: https://api.hotspotsystem.com/v2.0
Endpoint
Verify the resource owner's credentials
# |
model |
description |
200 |
Owner
|
Successful response |
500 |
Error
|
General error |
Endpoint
Get a list of the resource owner's locations
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's locations as options
Endpoint
Get a list of the resource owner's customers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's subscribers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's vouchers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's mac transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's voucher transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's social transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's paid transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's customers
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's customers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's subscribers
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's subscribers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's vouchers
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's vouchers at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's mac transactions
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's voucher transactions
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's social transactions
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's paid transactions
# |
type |
in |
description |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's mac transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's voucher transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's social transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Get a list of the resource owner's paid transactions at the specified location
# |
type |
in |
description |
locationId |
string |
path |
The ID of a location. |
fields |
string |
query |
A comma separated list of names of the response object's properties to filter by. |
sort |
string |
query |
One of the response object's property names to sort by. Prepend a negative sign for a descending order. |
limit |
string |
query |
The number of items to paginate to if the result contains multiple items. |
offset |
string |
query |
A zero based number of the page to show if it was paginated by the limit query parameter. |
Endpoint
Find out whether the api is reachable
# |
model |
description |
200 |
Pong
|
Successful response |
Model
# |
type |
description |
error |
string
| Error string |
{
"error": "string"
}
Model
# |
type |
description |
id |
string
| Unique identifier of the location. |
name |
string
| Name of the location. |
{
"id": "string",
"name": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": "string",
"name": "string"
}
]
}
Model
# |
type |
description |
id |
string
| Unique identifier of the user. |
user_name |
string
| User name of the person. |
name |
string
| Full name of the person. |
email |
string
| E-mail address of the user. |
company_name |
string
| Type of business entity associated with the person. |
address |
string
| Street name with house number. |
city |
string
| City name. |
state |
string
| County name. |
zip |
string
| Postal code. |
country_code |
string
| Two-letter country code. |
phone |
string
| Cell phone number of the user. |
social_network |
string
| Name of the social network that the user is registered with. |
social_id |
string
| Social network specific parameter. |
social_username |
string
| Social network specific parameter. |
social_link |
string
| Social network specific parameter. |
social_gender |
string
| Social network specific parameter. |
social_age_range |
string
| Social network specific parameter. |
social_followers_count |
string
| Social network specific parameter. |
registered_at |
string
| Date and time of the creation of the user. |
{
"id": "string",
"user_name": "string",
"name": "string",
"email": "string",
"company_name": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_network": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"registered_at": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": "string",
"user_name": "string",
"name": "string",
"email": "string",
"company_name": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_network": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"registered_at": "string"
}
]
}
Model
# |
type |
description |
id |
string
| Unique identifier of the user. |
user_name |
string
| User name of the person. |
name |
string
| Full name of the person. |
email |
string
| E-mail address of the user. |
company_name |
string
| Type of business entity associated with the person. |
address |
string
| Street name with house number. |
city |
string
| City name. |
state |
string
| County name. |
zip |
string
| Postal code. |
country_code |
string
| Two-letter country code. |
phone |
string
| Cell phone number of the user. |
social_network |
string
| Name of the social network that the user is registered with. |
social_id |
string
| Social network specific parameter. |
social_username |
string
| Social network specific parameter. |
social_link |
string
| Social network specific parameter. |
social_gender |
string
| Social network specific parameter. |
social_age_range |
string
| Social network specific parameter. |
social_followers_count |
string
| Social network specific parameter. |
registered_at |
string
| Date and time of the creation of the user. |
{
"id": "string",
"user_name": "string",
"name": "string",
"email": "string",
"company_name": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_network": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"registered_at": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": "string",
"user_name": "string",
"name": "string",
"email": "string",
"company_name": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_network": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"registered_at": "string"
}
]
}
Model
# |
type |
description |
serial |
string
| Unique identifier of the voucher. |
voucher_code |
string
| Users must type in this additional code. |
limit_tl |
number
| Traffic limit in bytes. If the return value is -1, no location context is set. |
simultaneous_use |
number
| The number of simultaneous connections allowed. |
limit_dl |
number
| Download limit in bytes. If the return value is -1, no location context is set. |
limit_ul |
number
| Upload limit in bytes. If the return value is -1, no location context is set. |
usage_exp |
string
| Expiration time left from today. |
validity |
number
| Can be used for the amount of minutes returned. |
price_enduser |
number
| The price it was sold for. |
currency |
string
| The currency of the price. |
{
"serial": "string",
"voucher_code": "string",
"limit_tl": 0,
"simultaneous_use": 0,
"limit_dl": 0,
"limit_ul": 0,
"usage_exp": "string",
"validity": 0,
"price_enduser": 0,
"currency": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"serial": "string",
"voucher_code": "string",
"limit_tl": 0,
"simultaneous_use": 0,
"limit_dl": 0,
"limit_ul": 0,
"usage_exp": "string",
"validity": 0,
"price_enduser": 0,
"currency": "string"
}
]
}
Model
# |
type |
description |
id |
number
| TODO |
operator |
string
| TODO |
location_id |
number
| TODO |
user_name |
string
| TODO |
action_date_gmt |
string
| TODO |
package_id |
string
| TODO |
user_agent |
string
| TODO |
customer |
string
| TODO |
newsletter |
number
| TODO |
company_name |
string
| TODO |
email |
string
| TODO |
address |
string
| TODO |
city |
string
| TODO |
state |
string
| TODO |
zip |
string
| TODO |
country_code |
string
| TODO |
phone |
string
| TODO |
q1 |
string
| TODO |
a1 |
string
| TODO |
q2 |
string
| TODO |
a2 |
string
| TODO |
q3 |
string
| TODO |
a3 |
string
| TODO |
q4 |
string
| TODO |
a4 |
string
| TODO |
q5 |
string
| TODO |
a5 |
string
| TODO |
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"action_date_gmt": "string",
"package_id": "string",
"user_agent": "string",
"customer": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"q1": "string",
"a1": "string",
"q2": "string",
"a2": "string",
"q3": "string",
"a3": "string",
"q4": "string",
"a4": "string",
"q5": "string",
"a5": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"action_date_gmt": "string",
"package_id": "string",
"user_agent": "string",
"customer": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"q1": "string",
"a1": "string",
"q2": "string",
"a2": "string",
"q3": "string",
"a3": "string",
"q4": "string",
"a4": "string",
"q5": "string",
"a5": "string"
}
]
}
Model
# |
type |
description |
id |
number
| TODO |
operator |
string
| TODO |
location_id |
number
| TODO |
user_name |
string
| TODO |
customer |
string
| TODO |
action_date_gmt |
string
| TODO |
amount |
number
| TODO |
currency |
string
| TODO |
user_agent |
string
| TODO |
newsletter |
number
| TODO |
company_name |
string
| TODO |
email |
string
| TODO |
address |
string
| TODO |
city |
string
| TODO |
state |
string
| TODO |
zip |
string
| TODO |
country_code |
string
| TODO |
phone |
string
| TODO |
language |
string
| TODO |
smscountry |
string
| TODO |
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"customer": "string",
"action_date_gmt": "string",
"amount": 0,
"currency": "string",
"user_agent": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"language": "string",
"smscountry": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"customer": "string",
"action_date_gmt": "string",
"amount": 0,
"currency": "string",
"user_agent": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"language": "string",
"smscountry": "string"
}
]
}
Model
# |
type |
description |
id |
number
| TODO |
operator |
string
| TODO |
location_id |
number
| TODO |
user_name |
string
| TODO |
action_date_gmt |
string
| TODO |
package_id |
string
| TODO |
user_agent |
string
| TODO |
customer |
string
| TODO |
newsletter |
number
| TODO |
company_name |
string
| TODO |
email |
string
| TODO |
address |
string
| TODO |
city |
string
| TODO |
state |
string
| TODO |
zip |
string
| TODO |
country_code |
string
| TODO |
phone |
string
| TODO |
social_id |
string
| TODO |
social_username |
string
| TODO |
social_link |
string
| TODO |
social_gender |
string
| TODO |
social_age_range |
string
| TODO |
social_followers_count |
string
| TODO |
social_network |
string
| TODO |
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"action_date_gmt": "string",
"package_id": "string",
"user_agent": "string",
"customer": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"social_network": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"action_date_gmt": "string",
"package_id": "string",
"user_agent": "string",
"customer": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"social_id": "string",
"social_username": "string",
"social_link": "string",
"social_gender": "string",
"social_age_range": "string",
"social_followers_count": "string",
"social_network": "string"
}
]
}
Model
# |
type |
description |
id |
number
| TODO |
operator |
string
| TODO |
location_id |
number
| TODO |
user_name |
string
| TODO |
customer |
string
| TODO |
action_date_gmt |
string
| TODO |
amount |
number
| TODO |
currency |
string
| TODO |
user_agent |
string
| TODO |
newsletter |
number
| TODO |
company_name |
string
| TODO |
email |
string
| TODO |
address |
string
| TODO |
city |
string
| TODO |
state |
string
| TODO |
zip |
string
| TODO |
country_code |
string
| TODO |
phone |
string
| TODO |
language |
string
| TODO |
smscountry |
string
| TODO |
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"customer": "string",
"action_date_gmt": "string",
"amount": 0,
"currency": "string",
"user_agent": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"language": "string",
"smscountry": "string"
}
Model
{
"metadata": {
"total_count": 0
},
"items": [
{
"id": 0,
"operator": "string",
"location_id": 0,
"user_name": "string",
"customer": "string",
"action_date_gmt": "string",
"amount": 0,
"currency": "string",
"user_agent": "string",
"newsletter": 0,
"company_name": "string",
"email": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"country_code": "string",
"phone": "string",
"language": "string",
"smscountry": "string"
}
]
}
Model
# |
type |
description |
ping |
string
| The response is always "pong". |
{
"ping": "string"
}
Model
# |
type |
description |
userId |
number
| |
operator |
string
| |
{
"userId": 0,
"operator": "string"
}
Model
# |
type |
description |
items |
Array<Object>
| |
{
"items": [
{
"id": "string",
"name": "string"
}
]
}