Sign In Enterprise Registrations API
All endpoints related to Registrations.
OpenAPI Specification
openapi: 3.0.2
info:
title: Sign In Solutions VMS AuditLogs Registrations API
version: 0.21.0
x-logo:
url: https://signinenterprise.com/wp-content/uploads/tg-logo-light@2.png
backgroundColor: '#FFFFFF'
altText: Sign In Solutions
href: https://signinsolutions.com/signinenterprise
description: 'The Traction Guest API is currently under limited release to select customers as we gather and iterate on feedback.
# Getting Started
If you are interested in getting early access to the API, please send us an email to [support@tractionguest.com](mailto:support@tractionguest.com).
We will also add you to our Slack channel where you can ask questions and get further help.
# Terms and Conditions
Please visit: [https://signinsolutions.com/compliance-hub](https://signinsolutions.com/compliance-hub)
# Versioning
This API follows [semantic versioning](https://semver.org/), which follows the `Major`.`Minor`.`Patch` format.
* The `Major` number increments when potentially incompatible changes are made.
* The `Minor` number increments when backwards-compatible additions are made.
* The `Patch` number increments when backwards-compatible bug-fixes are made.
'
contact:
name: API Support
url: https://signinsolutions.com/signinenterprise
email: support@tractionguest.com
servers:
- url: '{domain}'
variables:
domain:
enum:
- https://us.tractionguest.com/api/v3
- http://localhost:3000/api/v3
default: https://us.tractionguest.com/api/v3
security:
- TractionGuestAuth:
- all
- openid
- admin:webhooks
- watchlists:*
- watchlists:read
- watchlists:write
- users:*
- users:read
- users:write
- visitors:*
- visitors:read
- visitors:write
- parking:*
- parking:read
- parking:write
- locations:*
- locations:read
- locations:write
- hosts:*
- hosts:read
- hosts:write
- email_templates:*
- email_templates:read
- email_templates:write
tags:
- name: Registrations
description: All endpoints related to Registrations.
paths:
/registrations/{registration_id}:
summary: Path used to display a single Registration.
description: The REST endpoint/path used to get single instances of a `Registration`.
parameters:
- schema:
type: string
name: registration_id
in: path
required: true
get:
parameters:
- name: include
description: A list of comma-separated related models to include
schema:
type: string
in: query
responses:
'200':
content:
application/json:
schema:
$ref: ./models/RegistrationDetail.v1.yaml
examples:
Default:
value:
id: uuid
created_at: '2018-02-10T09:30:00Z'
name: some text
email: some text
company: some text
photo_url: some text
invite:
id: 96
first_name: some text
last_name: some text
start_date: '2018-02-10T09:30:00Z'
location:
id: 95
name: some text
watchlist_colour: GREEN
hosts:
- id: 61
email: some text
first_name: some text
last_name: some text
profile_pic_url: some text
department: some text
mobile_number: some text
- id: 57
email: some text
first_name: some text
last_name: some text
profile_pic_url: some text
department: some text
mobile_number: some text
invite_watchlist:
id: 7
external_colours:
- some text
- some text
internal_colours:
- some text
- some text
end_date: '2020-07-17T01:59:59.999Z'
email: some text
mobile_number: some text
visitor:
id: uuid
active: true
company: some text
created_via: some text
email: some text
first_name: some text
last_name: some text
mobile: some text
note: some text
profile_pic_content_type: some text
profile_pic_file_name: some text
profile_pic_file_size: some text
profile_pic_updated_at: some text
watchlist_level: some text
created_at: '2018-02-10T09:30:00Z'
updated_at: '2018-02-10T09:30:00Z'
guest_responses:
- title: some text
sequence: 9
id: uuid-1
page_type: some text
custom_fields:
- field_name: some text
field_value: some text
- field_name: some text
field_value: some text
- title: some text
sequence: 8
id: uuid-2
page_type: some text
custom_fields:
- field_name: some text
field_value: some text
- field_name: some text
field_value: some text
description: Successful response - returns a single `RegistrationDetail`.
'400':
content:
application/json:
schema:
$ref: ./models/ErrorsList.v1.yaml
examples:
default:
value:
errors:
- domain: some text
attribute: some text
code: some text
message: some text
- domain: some text
attribute: some text
code: some text
message: some text
description: A generic error
'403':
description: You do not have permission for this action
'404':
description: The specified Registration was not found
security:
- TractionGuestAuth:
- all
- signin:*
- signin:read
operationId: getRegistration
summary: Get a Registration
description: Gets the details of a single instance of a `Registration`
tags:
- Registrations
/registrations:
get:
summary: List all Registrations
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ./models/PaginatedRegistrationsList.v1.yaml
'400':
description: Bad Request
content:
application/json:
schema:
$ref: ./models/ErrorsList.v1.yaml
'401':
description: Unauthorized
operationId: getRegistrations
description: Gets a list of all `Registration` entities.
parameters:
- schema:
type: integer
in: query
name: limit
description: Limits the results to a specified number, defaults to 50
- schema:
type: integer
in: query
name: offset
description: Offsets the results to a specified number, defaults to 0
- schema:
type: string
in: query
name: location_ids
description: A comma separated list of Location IDs
- schema:
type: string
in: query
name: created_before
description: Restricts results to only those that were created before the provided date
- schema:
type: string
in: query
name: created_after
description: Restricts results to only those that were created after the provided date
- schema:
type: boolean
in: query
name: needs_confirmation
description: A confirmed `Registration` is one with an associated `Invite`. This filter returns those without an `Invite` when true, and those with an `Invite` when false.
tags:
- Registrations
components:
securitySchemes:
TractionGuestAuth:
openIdConnectUrl: https://us.tractionguest.com/.well-known/openid-configuration
type: openIdConnect