Sign In App Documentation

Resources

Group Resource

Key Type Description
id Number The id of the group.
name String The name of the group.
type String The type of the group, can be 'returning' or 'non-returning'.
visitors Array A list of visitor resources.

Returning Visitor Resource

Key Type Description
id Number The id of the returning visitor (member).
group_id Number The group ID the returning visitor is assigned to.
site_id Number Optional. The ID of the site the returning visitor is restricted to.
qr_codes Array Optional. A list of QR codes assigned.
personal_fields Object A object containing the personal fields like name, role, email etc.
photo_url String Optional. A URL to a photo of the visitor.
last_in String Optional. A string formatted in ISO-8601 format representing the last time the returning visitor signed in.
last_out String Optional. A string formatted in ISO-8601 format representing the last time the returning visitor signed out.
status String A string representing the returning visitor's status. Value are 'signed_in', 'signed_out' and 'unknown'.
permissions Object An object with the companion app permissions.

QR Codes Object

{
  "id": 345,
  "contents": "ABC123DEF456"
}

Personal Fields Object

This is a key value pair. name, role, mobile and email are system specific personal fields. All additional fields have been defined with in the client space.

{
  "name": "Joe Bloggs",
  "role": "Manager",
  "mobile": "+16789123456",
  "email": "user@example.com",
  "field1": "value1",
  "field2": 789,
  "field3": true
}

Permissions Object

This is a key value pair of permissions assigned to the returning visitor. These permissions are applicable to the companion app.

Key Type Description
can_access_firelist Boolean
can_pre_reg Boolean
can_mobile_sign_in Boolean
can_view_sign_in_history Boolean
can_auto_sign_in Boolean Dependent on the can_mobile_sign_in
can_access_today Boolean 
{
  "can_access_firelist": true,
  "can_pre_reg": false,
  "can_mobile_sign_in": true,
  "can_view_sign_in_history": false,
  "can_auto_sign_in": false,
  "can_access_today": false
}

Visitor Resource

Key Type Description
id Number The id of the visit.
group_id Number The group ID the visitor signed into.
returning_visitor_id Number Optional. The ID of the returning visitor.
name String The name of visitor that signed in.
photo_url String Optional. A URL to a photo of the visitor.
badge_url String Optional. A URL to a image of the badge printed for the visitor.
status String A string representing the visitor status. Value are 'signed_in', 'signed_out' and 'expected'.
in_datetime String Optional. A string formatted in ISO-8601 format representing the time the visitor signed in.
out_datetime String Optional. A string formatted in ISO-8601 format representing the time the visitor signed out.
expected_datetime String Optional. A string formatted in ISO-8601 format representing the time the visitor is pre-registered to arrive.
additional_fields Object Additional fields associated with the visitor taken during sign in or sign out.
personal_fields Object Personal fields associated with the visitor (for returning visitors only).
qr_codes Array List of QR code contents associated with the visitor.

Additional Field and Personal Field Object

This is a key value pair.

{
  "field1": "value1",
  "field2": 789,
  "field3": true
}

© 2024 Sign In App Ltd