Description
Returns all sign ins or search for wifi sign ins given date params.
Resource URL
GET https://wifi.socialidnow.com/api/sign_ins
Parameters
URL Parameters
limit
|
optional
|
page limit. Default: 1000. Max value: 10000
|
offset
|
optional
|
results offset.
|
since
|
optional
|
since date.
|
until
|
optional
|
date limit
|
Authentication
This API requires Wi-Fi API authentication. See Authentication.
Response
Response Status
ok (200)
|
The request was successfully.
|
unauthorized (401)
|
The authentication is wrong. See Authentication.
|
internal_server_error (500)
|
An unknown error happened.
|
Response Body
total
|
Number of sign ins found
|
count
|
Length of sign ins array at the result
|
offset
|
Given offset
|
[results]
|
Array of sign ins found
|
uuid
|
Sign in identifier.
|
venue_id
|
Venue id.
|
venue_name
|
Venue Name.
|
login_user_id
|
User indentifier.
|
client_mac
|
Mac Address linked to User.
|
ap_mac
|
Access Point Mac Address.
|
remote_ip
|
Remote IP Address.
|
accepted_at
|
Timestamp when the sign in was accepted.
|
created_at
|
Timestamp when the sign in was created.
|
updated_at
|
Timestamp of last sign in update.
|
Examples
Without Fields
Request
curl -X GET 'https://wifi.socialidnow.com/api/sign_ins' \
--user <wifi_api_id>:<wifi_api_secret>
Response
HTTP/1.1 200 Ok
Status: 200
Response Body
{
"total": 2,
"count": 2,
"offset": 0,
"results": [
{
"uuid": "cbcbf15c-7ee8-11e8-adc0-fa7ae01bbebc",
"venue_id": 2371,
"venue_name": "Venue1",
"login_user_id": "765",
"client_mac": null,
"ap_mac": null,
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-13T18:43:17Z",
"created_at": "2018-06-13T18:43:17Z",
"updated_at": "2018-06-13T18:43:17Z"
},
{
"uuid": "6cf0f878-fc5e-4cac-8be9-87bb6bb61451",
"venue_id": 9872,
"venue_name": "Venue2",
"login_user_id": "89675",
"client_mac": "0E-C7-54-82-B0-AD",
"ap_mac": "72-7C-08-93-E2-B0",
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-15T11:32:45Z",
"created_at": "2018-06-15T11:32:45Z",
"updated_at": "2018-06-15T11:32:45Z"
}
]
}
Using limit
Request
curl -X GET 'https://wifi.socialidnow.com/api/sign_ins?limit=1' \
--user <wifi_api_id>:<wifi_api_secret>
Response
HTTP/1.1 200 Ok
Status: 200
Response Body
{
"total": 2,
"count": 1,
"offset": 0,
"results": [
{
"uuid": "cbcbf15c-7ee8-11e8-adc0-fa7ae01bbebc",
"venue_id": 2371,
"venue_name": "Venue1",
"login_user_id": "765",
"client_mac": null,
"ap_mac": null,
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-13T18:43:17Z",
"created_at": "2018-06-13T18:43:17Z",
"updated_at": "2018-06-13T18:43:17Z"
}
]
}
Using offset
Request
curl -X GET 'https://wifi.socialidnow.com/api/sign_ins?offset=1' \
--user <wifi_api_id>:<wifi_api_secret>
Response
HTTP/1.1 200 Ok
Status: 200
Response Body
{
"total": 2,
"count": 1,
"offset": 1,
"results": [
{
"uuid": "6cf0f878-fc5e-4cac-8be9-87bb6bb61451",
"venue_id": 9872,
"venue_name": "Venue2",
"login_user_id": "89675",
"client_mac": "0E-C7-54-82-B0-AD",
"ap_mac": "72-7C-08-93-E2-B0",
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-15T11:32:45Z",
"created_at": "2018-06-15T11:32:45Z",
"updated_at": "2018-06-15T11:32:45Z"
}
]
}
Using since
Request
curl -X GET 'https://wifi.socialidnow.com/api/sign_ins?since=2018-06-15' \
--user <wifi_api_id>:<wifi_api_secret>
Response
HTTP/1.1 200 Ok
Status: 200
Response Body
{
"total": 1,
"count": 1,
"offset": 0,
"results": [
{
"uuid": "6cf0f878-fc5e-4cac-8be9-87bb6bb61451",
"venue_id": 9872,
"venue_name": "Venue2",
"login_user_id": "89675",
"client_mac": "0E-C7-54-82-B0-AD",
"ap_mac": "72-7C-08-93-E2-B0",
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-15T11:32:45Z",
"created_at": "2018-06-15T11:32:45Z",
"updated_at": "2018-06-15T11:32:45Z"
}
]
}
Using until
Request
curl -X GET 'https://wifi.socialidnow.com/api/sign_ins?until=2018-06-15' \
--user <wifi_api_id>:<wifi_api_secret>
Response
HTTP/1.1 200 Ok
Status: 200
Response Body
{
"total": 1,
"count": 1,
"offset": 0,
"results": [
{
"uuid": "cbcbf15c-7ee8-11e8-adc0-fa7ae01bbebc",
"venue_id": 2371,
"venue_name": "Venue1",
"login_user_id": "765",
"client_mac": null,
"ap_mac": null,
"remote_ip": "127.0.0.1",
"accepted_at": "2018-06-13T18:43:17Z",
"created_at": "2018-06-13T18:43:17Z",
"updated_at": "2018-06-13T18:43:17Z"
}
]
}