{"info":{"_postman_id":"a272ed32-5b9c-4186-a1e2-6cd03366a589","name":"ActIn Time Connected","description":"

To use the API, you should create an API key under Advanced > API Keys in your application. Enter your preferred Client ID and the system will generate a Client Secret. Use the client ID and Client Secret along with your user/employee credentials to generate an access token (See /auth endpoint) and use that access token to access each endpoint

Nearly every endpoint accepts some basic parameters via the query string including; where, limit, offset and order_by clauses (some knowledge of the underlying database structure is required or the structure can be interrogated via a GET request). By default, only a limited number of items are returned but the limit can be unset by setting limit to -1. If you are unbounding the limit, it is recommended that other filters are applied to avoid overloading the system.

Some endpoints are read-only and, while input is validated, you should set all appropriate fields, very few are filled automatically by the API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16789608","collectionId":"a272ed32-5b9c-4186-a1e2-6cd03366a589","publishedId":"2s9YsNfBRZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"34465D","highlight":"F05A28"},"publishDate":"2024-01-15T09:04:07.000Z"},"item":[{"name":"Absence Entitlement Policies","item":[{"name":"Get Absence Entitlement Policy","id":"d2fa2b1e-7cc6-426c-82cc-298b826453c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.ait-connected.co.uk/Roster/rest/v1/absence-entitlement/5","description":"

Gets a single absence entitlement policy from the system.

Gets the list of absence entitlement policies.

Gets a single absence reason from the system.

Gets the list of absence reasons.

Adds a new absence reason into the system.

Update an existing absence reason in the system.

Deletes a single absence reason from the system.

Gets a single access event record from the system.

Get a list of access event records in the system.

Adds a new access event record into the system.

Update an existing access record in the system.

Deletes a single access event record from the system.

Gets audit trail data. The sample query provided finds the most recent failed login event for a given user. As the audit trail can contain a significant amount of data, the warnings about providing appropriate filters and limits is particularly relevant to this endpoint.

Use your Client ID, Client Secret, Username and Password to obtain access to the API. If you maintain 2 sets of credentials with identical usernames, one of which is a user and one of which is an employee, you should specify scope=user or scope=employee to target the correct account type.

\n","urlObject":{"path":["authorisation"],"host":["https://demo.ait-connected.co.uk/Roster/rest/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5203ec0-ac2a-43e5-8958-c50cd7a3aa63"},{"name":"Token Info","id":"227abea5-0387-4af7-8c53-e38614fd73b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.ait-connected.co.uk/Roster/rest/v1/token_info","description":"

Validates a previously issued token to ensure it can still be used to interact with the system.

Get all data within a bespoke table. The table GET parameter must be specified and be listed in [Bespoke API Tables]. The sp GET parameter can be specified to execute a stored procedure listed in [Bespoke API Stored Procedures]. Parameters can be passed to the stored procedure by specifying a JSON string in the sp_payload GET parameter.

Get a single piece of data within a bespoke table. The table GET parameter must be specified and be listed in [Bespoke API Tables]. The sp GET parameter can be specified to execute a stored procedure listed in [Bespoke API Stored Procedures]. Parameters can be passed to the stored procedure by specifying a JSON string in the sp_payload GET parameter.

Adds a new bespoke record into the system. The table GET parameter must be specified and be listed in [Bespoke API Tables]. The sp GET parameter can be specified to execute a stored procedure listed in [Bespoke API Stored Procedures]. Parameters can be passed to the stored procedure by specifying a JSON string in the sp_payload GET parameter.

Update an existing bespoke record in the system. The table GET parameter must be specified and be listed in [Bespoke API Tables]. The sp GET parameter can be specified to execute a stored procedure listed in [Bespoke API Stored Procedures]. Parameters can be passed to the stored procedure by specifying a JSON string in the sp_payload GET parameter.

Deletes a single bespoke record from the system. The table GET parameter must be specified and be listed in [Bespoke API Tables]. The sp GET parameter can be specified to execute a stored procedure listed in [Bespoke API Stored Procedures]. Parameters can be passed to the stored procedure by specifying a JSON string in the sp_payload GET parameter.

Gets a single unprocessed booking from the system.

Get a list of unprocessed bookings in the system.

Adds a new unprocessed booking into the system.

Update an existing unprocessed booking in the system.

Deletes a single unprocessed booking from the system.

Gets company documents in the system along with their category, their priority and their distribution range.

Gets a single record from the 1st grouping. The company_grouping GET parameter must be specified and be between 1 and the number of groupings in your system.

Gets the list of the 1st grouping. The company_grouping GET parameter must be specified and be between 1 and the number of groupings in your system.

Adds a new record to the 1st grouping. The company_grouping GET parameter must be specified and be between 1 and the number of groupings in your system.

Updates an existing record in the 1st grouping. The company_grouping GET parameter must be specified and be between 1 and the number of groupings in your system.

Deletes a single record from the 1st grouping. The company_grouping GET parameter must be specified and be between 1 and the number of groupings in your system.

Gets cost centres in the system.

Gets the list of daily schedules.

Gets the list of document categories. If called from the employee context, the PWA policy will be applied to restrict which categories are visible. The pwa_context GET parameter can be one of job, personnel-view, personnel-add depending on which categories should be returned.

Get details of an active emergency in the system.

Marks an employee as safe during an emergency situation. The context GET parameter can be specified as user if an employee who is also a user wishes to mark employees under their remit as safe/unsafe.

Marks an employee as unsafe during an emergency situation. The context GET parameter can be specified as user if an employee who is also a user wishes to mark employees under their remit as safe/unsafe.

If the context GET parameter is emergency-start, the system will use the [Default Fire*] settings to start an emergency.

If the context GET parameter is emergency-stop, the system will use the [Default Fire*] settings to stop an emergency.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a272ed32-5b9c-4186-a1e2-6cd03366a589","id":"a272ed32-5b9c-4186-a1e2-6cd03366a589","name":"ActIn Time Connected","type":"collection"}},"urlObject":{"path":["emergency"],"host":["https://demo.ait-connected.co.uk/Roster/rest/v1"],"query":[{"key":"context","value":"emergency-stop"}],"variable":[]}},"response":[],"_postman_id":"5c73bf51-ba5b-4c9b-889d-19533102aa53"},{"name":"Trigger Fire","id":"eb1e11e1-c52c-498f-84f2-19eeea385483","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{fire_username}}"},{"key":"password","value":"{{fire_password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\"terminal_code\":\"1\",\"fire\":true,\"timestamp\":1628335357794}"},"url":"{{system_url}}emergency/fire","urlObject":{"path":["fire"],"host":["{{system_url}}emergency"],"query":[],"variable":[]}},"response":[{"id":"15d4a5ea-3384-446b-a145-54ef340accba","name":"Trigger Fire","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\"terminal_code\":\"1\",\"fire\":true,\"timestamp\":1628335357794}"},"url":"https://demo-full.trspro.live/Roster/emergency/fire"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 25 Jul 2023 14:23:28 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"TRS Pro"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"eb1e11e1-c52c-498f-84f2-19eeea385483"}],"id":"d40620b8-3ab4-4997-9597-17abd6c4a344","_postman_id":"d40620b8-3ab4-4997-9597-17abd6c4a344","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a272ed32-5b9c-4186-a1e2-6cd03366a589","id":"a272ed32-5b9c-4186-a1e2-6cd03366a589","name":"ActIn Time Connected","type":"collection"}}},{"name":"Employee","item":[{"name":"Employee Absence Entitlement","item":[{"name":"Get Employee Absence Entitlement Periods","id":"95209c42-fbf9-438e-9967-ae6c6b3c2547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.ait-connected.co.uk/Roster/rest/v1/employee-absence-entitlement-periods","description":"

Gets a list of absence entitlement periods for the employees.

Gets a single absence for an employee from the system.

Gets a list of absences booked for employees.

Adds a new approved and finalised absence of a specific reason spanning the provided dates for an employee into the system and recalculates the relevant dates. Please note that where the absence reason does not include rest days and it spans rest days, this endpoint may generate multiple absence records.

Update an existing absence for an employee in the system and recalculates the relevant dates.

Deletes a single accident for an employee record from the system.

Gets a single title record from the system.

Gets the list of accidents in which employees have been involved.

Adds a new accident record for an employee into the system.

Update an existing accident for an employee in the system.

This endpoint requires you to pass in [from] and [to] parameters (which can be in the future) and it will return the default schedule for the employee or employees (if the employee is also a user) along with any absences and roster shift detail. It also returns home groupings and dates of birth to allow a comprehensive calendar to be rendered. The context GET parameter can be specified as user if an employee who is also a user wishes to retrieve the calendar for employees under their remit. The from and to GET parameters should be provided as YYYY-MM-DD dates.

Get a list of employee changes in the system.

Get a single employee change from the system.

Adds a new employee change record to the system.

Updates an existing employee change in the system.

Deletes an existing employee change from the system.

Get a list of employee employment records in the system.

Get a single employee employment record from the system.

Adds a new employee employment record to the system.

Updates an existing employee employment record in the system.

Deletes an existing employee employment record from the system.

Gets a list of absences booked for employees.

Adds a new form to a job.

Deletes a single job form from the system.

Get a list of employee pay periods in the system.

Get employee rostered shifts from the system including tasks and cross-rostered groupings.

This endpoint requires you to pass in [from] and [to] parameters (which can be in the future) and it will return the default schedules for the employees based on their period schedule and rotation. The from and to GET parameters should be provided as YYYY-MM-DD dates.

Gets a summary timesheet for the employees with absences, swipes, rates and static registers. The job or cost_centre GET parameter can be specified to include job costing and cost centre records.

Adds a new timesheet for the employee. The job or cost_centre GET parameter can be specified to add job costing or cost centre timesheets. Please note that start_time and stop_time will be anchored to date_and_time and stop_time will be advanced to the following day if it is before start_time. If start_terminal_id and stop_terminal_id are not specified, they will default to [Pwa Default Terminal Description]. If status is not specified, it will default to 0. The data will be automatically calculated upon modification.

Deletes a timesheet for an employee. The job or cost_centre GET parameter can be specified to delete job costing or cost centre records.

Get a list of employee user-defined fields in the system.

Get a single employee user-defined field from the system.

Adds a new employee user-defined field record to the system.

Updates an existing employee user-defined field in the system.

Deletes an existing employee user-defined field in the system.

Gets a single employee record from the system. The query GET parameter can be provided and contain a JSON string of key/value pairs where the key is roster_range_id, zone_id, last_x_hours or search and the value is a valid data type for that field. This can be used to restrict the returned data. The restrict_data GET parameter will force user/employee relationships to be rebuilt and only a subset of employee information will be returned; i.e. employee ID, badge and name.

Get a list of employees in the system along with their groupings, current roll call status and PWA policy. Additionally, if the query string parameter ?context=user is provided and the employee is a user, information about all employees under their user account can be obtained. The context GET parameter can be specified as user if an employee who is also a user wishes to retrieve information for all employees under their remit. If context is emergency and the employee is also a user, all employees in zones covered by that user can be retrieved. The query GET parameter can be provided and contain a JSON string of key/value pairs where the key is roster_range_id, zone_id, last_x_hours or search and the value is a valid data type for that field. This can be used to restrict the returned data. The restrict_data GET parameter will force user/employee relationships to be rebuilt and only a subset of employee information will be returned; i.e. employee ID, badge and name. The rebuild_user_employee_relationships GET parameter will force user/employee relationships to be rebuilt.

Adds a new employee into the system.

Update an existing employee in the system.

Deletes a single employee from the system.

Gets a single accident for an employee record from the system.

Gets the list of accident reasons.

Adds a new accident reason into the system.

Update an existing accident reason in the system.

Deletes a single accident reason from the system.

Gets a single personnel document from the system.

Get a list of personnel documents in the system.

Adds a new document to a personnel record.

Deletes a single personnel document from the system.

This endpoint can be used to update document meta data for a particular employee. The meta data \"action\" can be read, accept or signature. \"document_type\" should be \"company-document\" or \"personnel-document\". Generally this API endpoint will call the onPWAServerEmployeeDocumentMetaUpdated when meta data is successfully updated.

This endpoint can be used to delete files associated with a personnel form.

Gets a single marital status record from the system.

Gets the list of marital statuses.

Adds a new marital status into the system.

Update an existing marital status in the system.

Deletes a single marital status from the system.

Gets a single personnel message from the system.

Get a list of personnel messages in the system.

Adds a new message to a personnel record.

Deletes a single personnel message from the system.

This endpoint can be used to update message meta data for a particular employee. The meta data \"action\" can be read, accept or signature. \"mesage_type\" should be \"company-message\" or \"personnel-message\". Generally this API endpoint will call the onPWAServerEmployeeMessageMetaUpdated when meta data is successfully updated.

Gets a single nationality record from the system.

Gets the list of nationalities.

Adds a new nationality into the system.

Update an existing nationality in the system.

Deletes a single nationality from the system.

Gets a single relationship record from the system.

Gets the list of relationships.

Adds a new relationship into the system.

Update an existing relationship in the system.

Deletes a single relationship from the system.

Gets a single title record from the system.

Gets the list of titles.

Adds a new title into the system.

Update an existing title in the system.

Deletes a single title from the system.

Manages fingerprint registrations in the system. This endpoint can be used to create new fingerprint registrations and verify existing fingerprint registrations as well as deleting fingerprint registrations and retrieving a list of fingerprint registrations in an appropriate format. Please refer to the [action] parameter for more information on the capabilities of this endpoint. Please note that PHP 8.3 is required for this endpoint.

Gets the list of forms. If called from the employee context, the PWA policy will be applied to restrict the list of forms to only those in categories that the policy allows.

Gets the list of form categories. If called from the employee context, the PWA policy will be applied to restrict which categories are visible. The pwa_context GET parameter can be one of job, personnel-view, personnel-add depending on which categories should be returned.

Gets a single GPS record from the system.

Get a list of GPS records in the system.

Adds a new GPS record into the system.

Update an existing GPS record in the system.

Deletes a single GPS record from the system.

Get client side hooks intended to be run in the PWA environment. The app GET parameter can be provided to return hooks specific to an application, e.g. pwa, visitor etc.

Runs a server side hook with the provided form data.

Adds a new document to a job.

Deletes a single job document from the system.

Adds a new form to a job.

Deletes a single job form from the system.

Adds a new note to a job.

Deletes a single job note from the system.

Adds an existing part to a job if part_id is specified. Or, if code, description and part_ref_id are specified, a new part is created and associated with a job.

Deletes a single job part from the system.

Adds a new photo to a job.

Deletes a single job photo from the system.

Update an existing job employee record. This endpoint is generally used to update the status of an employee's activity on a job, e.g. changing to In progress, Paused, Completed etc.

Get detailed information about a specific job in the system including documents, who is assigned, forms, notes, operations, parts and photos. The endpoint will interrogate the PWA policy assigned to the employee and only return appropriate information.

Get a list of jobs in the system. The endpoint will interrogate the employee's PWA policy and return either all jobs or only jobs that are assigned to the employee.

This endpoint can be used to delete files associated with a form that has been completed as part of a job.

This API endpoint requires the definition of a 'licence' database in the database.php configuration file. That database should contain a licence server schema. This endpoint will return details of licences issued where the distributor matches the authorised user name. If no 'licence' database is available, this endpoint will return the details of the currently installed licence.

This API endpoint requires the definition of a 'licence' database in the database.php configuration file. That database should contain a licence server schema. This endpoint will return details of a single licence issued where the distributor matches the authorised user name. If no 'licence' database is available, this endpoint will return the details of the currently installed licence.

Get all data within a mobile worker table. The table GET parameter must be specified and be listed in [Mobile Worker API Tables].

Adds data to a mobile worker table. The table GET parameter must be specified and be listed in [Mobile Worker API Tables]. This endpoint accepts raw XML input that is serialized from an ADODB.Recordset that can be parsed as a SimpleXMLElement and which corresponds to the schema specified by the table GET parameter.

Deletes a single record from a mobile worker table. The table GET parameter must be specified and be listed in [Mobile Worker API Tables].

Gets message categories in the system. The pwa_context GET parameter can be one of job, personnel-view, personnel-add depending on which categories should be returned.

Get a list of muster points in the system.

Get a single muster point in the system.

Adds a new muster point into the system.

Update an existing muster point in the system.

Deletes a single muster point from the system.

Gets job operations in the system.

Gets the list of part categories. If called from the employee context, the PWA policy will be applied to restrict which categories are visible.

Get a list of parts in the system.

Get a list of passkey registrations for a given username and context.

Manages passkey registrations in the system. This endpoint can be used to create new passkey registrations and verify existing passkey registrations as well as deleting passkey registrations and retrieving a list of passkey registrations in an appropriate format. Please refer to the [fn] parameter for more information on the capabilities of this endpoint.

Gets a single period schedule from the system.

Gets the list of period schedules.

Gets the list of photo categories. If called from the employee context, the PWA policy will be applied to restrict which categories are visible.

This endpoint is only available if accessing the API as a user or as an employee with the parameter ?context=user specified. The endpoint will use return a list of personnel ranges under the user's remit.

Gets PWA policies in the system.

Gets a single PWA policy in the system.

Adds a new PWA policy into the system.

Updates an existing PWA policy in the system.

Deletes an existing PWA policy from the system.

Gets real time messages in the system. If this endpoint is accessed from the employee context, the employee must be a recipient by virtue of direct assignment or their personnel range of this real time message in order for the message to be returned.

Gets a single real time message in the system. If this endpoint is accessed from the employee context, the employee must be a recipient by virtue of direct assignment or their personnel range of this real time message in order for the message to be returned.

Adds a new real time message into the system.

Updates an existing real time message into the system.

Deletes an existing real time message from the system.

Gets shift requests applicable to an employee. If the pwa_context GET parameter is other, shift requests pertaining to other employees will be retrieved (i.e. potential swaps) and if it's not other, shift requests pertaining to oneself will be retrieved.

Gets a single shift request applicable to an employee.

Adds a new shift request into the system for an employee. The shift_request_type can be 1 = drop, 2= swap, 3 = extra shift request. Where shift_request_type is 1 or 2, roster_shift_id should be provided and valid. Where shift_request_type is 3, shift_request_extra_id should be provided and valid.

Deletes an existing shift request for an employee from the system.

Gets shift request extras available to an employee.

Gets a single shift request extra available to an employee.

Adds a new shift request extra into the system.

Updates an existing shift request extra in the system.

Deletes an existing shift request extra from the system.

Gets shift responses applicable to an employee. If the pwa_context GET parameter is other, shift responses from other employees will be retrieved (i.e. swap responses) and if it's not other, shift responses from oneself to other employee potential swaps are retrieved.

Gets a single shift response applicable to an employee.

Adds a new shift response into the system.

Updates an existing shift response in the system.

Deletes an existing shift response from the system.

Get the rate, absence category and static register descriptions from the system. The app GET parameter can be provided to return settings specific to an application, e.g. pwa, visitor etc.

Get a list of tasks in the system.

Gets a single terminal from the system.

Get a list of terminals in the system.

Adds a new terminal into the system.

Update an existing terminal in the system.

Deletes a single terminal from the system.

Get a list of employment records, training policies and training records from the system.

Get a list of visits in the system. If the context GET parameter is search, the API endpoint can be used to search for visitors due to check-in/out. In this mode, the endpoint can accept additional GET parameters to refine the search, notably; visitor_status, location_id, name, visit_hash.

Add a new visit into the system. Generally a visitor should be added with visitor_status = 0, i.e. Expected. If the visitor is a walk-in, walk_in should be set to 1 however if they're pre-registered, walk_in should be 0.

Updates an existing visit in the system. Note that because this may include uploaded files, it must be a POST request but you should specify the proxy method of PUT.

Gets documents that apply to a particular visitor policy along with associated document meta data if a particular visit/visitor is provided. The visitor_policy_id GET parameter must be provided as this determines which visitor policy is applied and thus which documents are returned. The visit_visitor_id GET parameter is optional but where it is provided, the meta data associated with each document, e.g. whether it has been read, accepted or signed will be returned.

This endpoint can be used to update document meta data for a particular visitor's visit. The meta data \"action\" can be read, accept or signature. \"document_type\" should be \"company-document\". Generally this API endpoint will call the onPWAServerVisitorDocumentMetaUpdated when meta data is successfully updated.

Adds a new visitor form record into the system.

Updates an existing visitor form record in the system. Note that because this may include uploaded files, it must be a POST request but you should specify the proxy method of PUT.

Deletes a single visitor form record from the system.

This endpoint can be used to delete files associated with a form that has been completed during a visit check-in.

Gets visitor policies in the system.

Gets a single visitor policy in the system.

Adds a new visitor policy into the system.

Updates an existing visitor policy in the system.

Deletes an existing visitor policy from the system.

This endpoint is only available if accessing the API as an employee. The endpoint will use your PWA policy to determine who else is having time off.

Gets zones in the system.

Gets a single zone in the system.

Adds a new zone into the system.

Updates an existing zone in the system.

Deletes an existing zone from the system.