Beta Visitor API
Visitor API ¶
The Visitor API provides access to visitors, registrations, visitor checkin, and visitor checkout
Endpoints
The base URL will be https://siteaddress/api/v3/
All endpoints in the document are relative to this url.
Authentication
In order to authenticate your request, in each request include the following in the request headers. All requests are over HTTPS.
x-auth-password: password
x-auth-username: usernameGlobal Request Params
| Paramater | Value |
|---|---|
| pageSize | number of results to show (default: 10) |
Visitor ¶
Visitor-related resources of Visitor API
*Note: The only way to create a visitor is by creating a registration.
Visitor ¶
Retrieve a single visitorGET/visitors/{id}
Example URI
GET /visitors/id
URI Parameters
- id
string(required)ID of the Visitor
Response
200Body
{
status: "ok",
response: {
visitorId: {
id: 6
},
visitorInfo: {
firstName: "Janice",
lastName: "Coney",
company: "Janice Exports",
dateCreated: "2009-03-10T12:09:40.863",
createdBy: 231944,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "123 Main St",
state: "Ga",
postalCode: "12345",
phone: "2388923973"
},
visitorCustomFields: {}
}
}Visitor Collection ¶
A list of visitors.
List of VisitorsGET/visitors/{email,phone}
Example URI
GET /visitors/donotreply@email.com&1234567890
URI Parameters
string(optional) Example: donotreply@email.comEmail of the visitor
- phone
string(optional) Example: 1234567890Phone of the visitor
Response
200Body
{
status: "ok",
response: {
items: [
{
visitorId: {
id: 1
},
visitorInfo: {
firstName: "Imtiyaz",
lastName: "Momin",
company: "iOffice",
email: "donotreply@email.com",
dateCreated: "2007-12-28T21:52:54.857",
createdBy: 14719,
imageId: {
id: 1
},
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "Houston",
state: "Texas",
postalCode: "77019",
phone: "1234567890"
},
visitorCustomFields: {}
},
{
visitorId: {
id: 2
},
visitorInfo: {
firstName: "freda",
lastName: "alexander",
company: "IKON",
dateCreated: "2008-07-11T13:20:26.07",
createdBy: 228293,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "",
state: "ga",
postalCode: "30260",
phone: "404-395-3883"
},
visitorCustomFields: {}
},
{
visitorId: {
id: 3
},
visitorInfo: {
firstName: "James",
lastName: "Alexander",
company: "UPS",
dateCreated: "2008-10-06T21:37:24.74",
createdBy: 223838,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "111111",
state: "GA",
postalCode: "30260",
phone: "777777777777"
},
visitorCustomFields: {}
},
{
visitorId: {
id: 4
},
visitorInfo: {
firstName: "Todd",
lastName: "Kieffer",
company: "IKON",
dateCreated: "2008-10-06T21:39:02.873",
createdBy: 223838,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "5550 Peachtree Pkwy",
state: "GA",
postalCode: "30092",
phone: "770-326-4345"
},
visitorCustomFields: {}
},
{
visitorId: {
id: 5
},
visitorInfo: {
firstName: "Allison",
lastName: "Terrellyrt",
company: "Unknown",
dob: "",
dateCreated: "2009-03-10T11:48:02.813",
createdBy: 231944,
dateUpdated: "2016-04-29T16:04:17",
lastUpdatedBy: 237089,
imageId: {
id: 4371
},
active: true
},
visitorIdentification: {
stateDLNumber: "6505"
},
visitorAddress: {
address: "asfkjasfj",
state: "ga",
postalCode: "30331",
phone: "1346487895556"
},
visitorCustomFields: {
custom01: "",
custom09: "10/15/16"
}
},
{
visitorId: {
id: 6
},
visitorInfo: {
firstName: "Janice",
lastName: "Coney",
company: "Test",
dateCreated: "2009-03-10T12:09:40.863",
createdBy: 231944,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "Test",
state: "Ga",
postalCode: "12345",
phone: "Test"
},
visitorCustomFields: {}
},
{
visitorId: {
id: 7
},
visitorInfo: {
firstName: "George",
lastName: "Rogers",
company: "iOffice",
dateCreated: "2009-06-02T09:47:39.117",
createdBy: 14719,
dateUpdated: "2012-02-29T10:22:38",
lastUpdatedBy: 14719,
imageId: {
id: 3
},
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "",
state: "",
postalCode: "",
phone: ""
},
visitorCustomFields: {
custom09: "-1"
}
},
{
visitorId: {
id: 8
},
visitorInfo: {
firstName: "Sam",
lastName: "Rogers",
company: "ioffice",
dateCreated: "2009-06-02T13:37:15.457",
createdBy: 231944,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "",
state: "",
postalCode: "",
phone: ""
},
visitorCustomFields: {}
},
{
visitorId: {
id: 9
},
visitorInfo: {
firstName: "Sam",
lastName: "Roberts",
company: "iOffice",
dateCreated: "2009-06-02T13:38:09.377",
createdBy: 231944,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "",
state: "",
postalCode: "",
phone: ""
},
visitorCustomFields: {}
},
{
visitorId: {
id: 10
},
visitorInfo: {
firstName: "Sam",
lastName: "Robertson",
company: "iOffice",
dateCreated: "2009-06-02T13:42:53.423",
createdBy: 231944,
active: true
},
visitorIdentification: {},
visitorAddress: {
address: "",
state: "",
postalCode: "",
phone: ""
},
visitorCustomFields: {}
}
],
page: 1,
size: 10,
totalPages: 4383,
totalItems: 43823
}
}Registrations ¶
Registrations-related resources of Visitor API
Registration Collection ¶
A list of registrations.
List of RegistrationsGET/visitors/registrations/{?email,phone}
Example URI
GET /visitors/registrations/?email=donotreply@email.com&phone=1234567890
URI Parameters
string(optional) Example: donotreply@email.comEmail of the visitor attached to the registration
- phone
string(optional) Example: 1234567890Phone of the visitor attached to the registration
Response
200Body
{
status: "ok",
response: {
items: [
{
id: {
id: 438
},
visitorId: {
id: 191
},
userId: 1,
statusId: 2,
signatureId: {
id: "568f1873-995e-44b0-aec7-39d3fcfc47b9"
}
},
{
id: {
id: 439
},
visitorId: {
id: 192
},
userId: 1,
signatureId: {
id: "206307a8-0eb8-4d2a-af3c-8f0b343574ad"
}
},
{
id: {
id: 440
},
visitorId: {
id: 193
},
userId: 1,
signatureId: {
id: "137e70e3-9815-4530-99a1-1eaa4c4a072b"
}
},
{
id: {
id: 441
},
visitorId: {
id: 194
},
userId: 1,
signatureId: {
id: "91ba5c41-ccaf-49da-967f-2a298f8a0f2d"
}
},
{
id: {
id: 442
},
visitorId: {
id: 195
},
userId: 1,
signatureId: {
id: "058fe018-c37a-4775-b973-d4f4f0ae88d2"
}
},
{
id: {
id: 443
},
visitorId: {
id: 196
},
userId: 1,
signatureId: {
id: "4110b036-e330-419b-9027-551295f5e13a"
}
},
{
id: {
id: 444
},
visitorId: {
id: 197
},
userId: 1,
signatureId: {
id: "1cadcff2-7162-49a9-9839-74f882c7ccf6"
}
},
{
id: {
id: 445
},
visitorId: {
id: 198
},
userId: 1,
signatureId: {
id: "4594b676-0f3c-4d99-af1b-14cb96e60913"
}
},
{
id: {
id: 446
},
visitorId: {
id: 199
},
userId: 1,
signatureId: {
id: "d1a80c19-5d06-4fa8-9ffb-7b27c48ca233"
}
},
{
id: {
id: 447
},
visitorId: {
id: 200
},
userId: 1,
signatureId: {
id: "4438ae90-16e0-44be-848a-ec941c6fef7e"
}
}
],
page: 1,
size: 10,
totalPages: 427,
totalItems: 4261
}
}Create a RegistrationPOST/visitors/registrations/
The following attributes are required to create a Registration:
Example URI
POST /visitors/registrations/
Request
Headers
Content-Type: application/jsonBody
{
userId: 237068,
visitor: {
image: 'BASE-64-IMAGE-STRING',
signature: 'BASE-64-IMAGE-STRING',
visitorAddress: {
phone: "6665554443",
},
visitorInfo: {
firstName: "Jimmy",
lastName: "Hendrix",
email: "jimmy@hendrix.com"
}
},
visitorType: "Contractor"
}Response
200Body
{
status: "ok",
response: {
id: {
id: 44241
},
visitorId: {
id: 43828
},
userId: 237068,
centerId: 119,
arrivalDateTime: "2019-05-22T12:27:25.4",
statusId: 2,
dateCreated: "2019-05-22T12:27:25.4",
createdBy: 237068,
signatureId: {
id: "fbda7dd6-d511-40dd-9b92-98dfa32c5ff0"
},
deviceName: ""
}
}Delete a RegistrationDELETE/visitors/registrations/
Example URI
DELETE /visitors/registrations/
URI Parameters
- id
string(required)ID of the Visitor
Response
200Body
{
status: "ok",
response: {
id: {
id: 40017
},
registrationInfo: {
id: {
id: 43839
},
userId: 236210,
centerId: 72,
arrivalDateTime: "2018-03-05T17:37:52.03",
checkInDateTime: "2018-03-07T15:14:48",
checkOutDateTime: "2019-05-22T14:24:47.013",
dateCreated: "2018-03-07T15:14:48",
signatureId: {
id: "87c171cd-861b-41a8-bccf-09645bb35d24"
}
},
archivedByName: "Visitor service",
archivedDateTime: "2019-05-22T14:24:47.013",
visitorInfo: {
id: {
id: 43389
},
visitorInfo: {
fullName: "Kirk Knight",
imageId: {
id: 70489
}
},
visitorIdentification: {},
visitorAddress: {
phone: "678"
}
},
customFields: {}
}
}Types ¶
Types-related resources of Visitor API
Types ¶
Retrieve a single typeGET/types/{id}
Example URI
GET /types/id
URI Parameters
- id
string(required)ID of the Type
Response
200Body
{
status: "ok",
response: {
id: {
id: 2
},
name: "Employee",
active: true
}
}Types Collection ¶
A list of visitors.
List of TypesGET/types
Example URI
GET /types
Response
200Body
{
status: "ok",
response: [
{
id: {
id: 1
},
name: "Visitors",
active: true
},
{
id: {
id: 2
},
name: "Employee",
active: true
},
{
id: {
id: 4
},
name: "Contractor",
active: true
},
{
id: {
id: 5
},
name: "Volunteer",
active: true
},
{
id: {
id: 7
},
name: "iOFFICE Guest",
active: true
}
]
}