Aladtec API Documentation

Base URL: https://secure#.aladtec.com/example/api/v2

Preface

The Aladtec API can be used to retrieve, create, or update information contained in an Aladtec system, specifically:

The Aladtec API is implemented as a JSON web service that accepts authenticated HTTP requests, then returns a response with an HTTP status code and a JSON payload. No separate installation is required to use the Aladtec API.

General Information

  1. Date/Time is expressed in the timezone defined by the Aladtec system being accessed
  2. Date/Time format is YYYY-MM-DDTHH:MM, where YYYY = year, MM = month, DD = day, T = separator character, HH = hours (expressed in 24 hour notation), MM = minutes, e.g. 2018-05-01T17:30
  3. Date format is YYYY-MM-DD, where YYYY = year, MM = month, DD = day, e.g. 2018-05-01
  4. Time format is HH:MM, where HH = hours (expressed in 24 hour notation), MM = minutes, e.g. 14:30.
  5. Aladtec API will attempt to return an appropriate HTTP status code for every request
  6. Parameter keys and values are case sensitive
  7. Only data contained within the requested date range will be included in the response; however, a response may include additional information to indicate if the data extends outside of the requested date range
  8. Aladtec URLs are subject to change at the discretion of Aladtec

API Rate Limits

An Aladtec subscription provides 50 requests per minute and 2500 requests per rolling 24 hour period. Once the rate limit has been reached, a status code of 429 (Too Many Requests), will be returned until the rate limit automatically resets.

If a higher rate limit is required, please contact Aladtec Support at 888.749.5550.

API Profiles

Aladtec can create multiple API profiles for your organization, each with access to different data. Not all data is available by default.

If you would like to configure API profiles, please contact Aladtec Support at 888.749.5550.

Authentication

Aladtec follows OAuth 2.0 standards for authentication. All API endpoints require authentication using a valid, non-expired access token. To get API tokens for an Aladtec system you must have received a client ID and a client secret for that system by contacting Aladtec Support. The client secret must remain confidential as it allows unrestricted access to an Aladtec system's data. All access tokens will expire seven days after they are created.

Getting an Access Token

Aladtec has implemented Client Credentials authentication for obtaining access tokens. Tokens obtained using Client Credentials will give unrestricted access to a system's data.

/oauth

post

Generates new API access tokens given valid credentials

post https://secure#.aladtec.com/example/api/v2/oauth/token

Description

Generates new API access tokens given valid credentials

Request Body

{} application/json

grant_type string required Possible values: 'client_credentials'
client_id string required Client ID used to identify your software interacting with Aladtec
client_secret string required Confidential secret to authenticate your software

Example: 

{
  "grant_type": "client_credentials",
  "client_id": "sys-234F3SFSE",
  "client_secret": "ERIOBNSLWVNUIEW3843H3B3B3B3N2MN2"
}

HTTP status code 200

Response Body

{} application/json

token string

The new API token

expires integer

UNIX timestamp value of when the API token expires

Example: 

{
  "token": "GdreEkwMnZUcU1tcmQ3aHJ1cXM1LmZDR05neUc4WklTcE44SHlyNHNwe",
  "expires": 1553634604
}

<?php 

/* Set your system URL, client ID, and client secret here. */
$base_url = 'https://secure#.aladtec.com/example/api/v2';
$client_id = 'sys-234F3SFSE';
$client_secret = 'ERIOBNSLWVNUIEW3843H3B3B3B3N2MN2';

$url = $base_url . '/oauth/token';
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Content-Type: application/json'
) );
curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( array(
	'grant_type' => 'client_credentials',
	'client_id' => $client_id,
	'client_secret' => $client_secret
) ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL, client ID, and client secret here. */
var base_url = 'https://secure#.aladtec.com/example/api/v2';
var client_id = 'sys-234F3SFSE';
var client_secret = 'ERIOBNSLWVNUIEW3843H3B3B3B3N2MN2';

var xhr = new XMLHttpRequest();

var url = base_url + '/oauth/token';
xhr.open( 'POST', url );

xhr.send( JSON.stringify( {
	grant_type: 'client_credentials',
	client_id: client_id,
	client_secret: client_secret
} ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});

Response Codes

Code Text Description
200 Ok Request was successful
201 Created Resource was created successfully
204 No Content Request was successful and no response content was returned
400 Bad Request Request was invalid, may be due to missing or incorrect parameters
401 Unauthorized Authentication credentials were invalid or missing, may be due to expired token
403 Forbidden The API credentials used do not have access to the resource requested
404 Not Found The URL path was not found
405 Method Not Allowed An invalid HTTP method was specified for the resource. For example, a GET request was made to /oauth/token which only supports POST requests.
429 Too Many Requests The rate limit for the Aladtec system was reached and the request cannot be completed
500 Internal Server Error A problem has occurred on Aladtec servers, if the error continues - contact Aladtec Support for additional assistance

The Aladtec API will include additional details in the response which can be used for troubleshooting, for example:

  [{
        "error": "Invalid credentials.",
        "detail": "An API token was either not provided or invalid.  A valid API token must be set in the Authorization Bearer header."
  }]

Resources

/members

Routes for retrieving and updating Member Database information

get

Returns members and the member's associated Member Database attributes. Attributes must be...

post

Creates a new member in the Member Database.

post https://secure#.aladtec.com/example/api/v2/members

Description

Creates a new member in the Member Database.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

is_active boolean optional Members are either active or inactive
first_name string required Member given name
last_name string required Member family name
login string required Member login name
mobile_phone string optional Mobile phone number
primary_email string required Primary email address
secondary_emails array optional Email addresses not considered the primary_email
date_hired string optional Date the member was hired
employee_type_id integer optional ID of the employee type assigned to the member
work_group_id integer required ID of the work group assigned to the member
schedule_ids array optional List of schedule IDs the member is qualified to work on
position_qualification_ids array optional List of position qualification IDs a member is qualified for
custom_attributes array optional Attributes in the Member Database, defined per Aladtec system. Each attribute contains an attribute_id (integer) and a value. The attribute can be Text (string), Date (string), Number (int), Single Option (array of IDs), or Multi Option (array of IDs). Note: Any attribute IDs or option IDs that are invalid will be ignored and won't be saved.

Example: 

{
  "is_active": true,
  "first_name": "John",
  "last_name": "Smith",
  "login": "johnsmith",
  "primary_email": "jsmith@company.com",
  "secondary_emails": [
    "jsmith@example.com",
    "jsmith2@example.com"
  ],
  "employee_type_id": 7,
  "work_group_id": 5,
  "date_hired": "2019-01-01",
  "schedule_ids": [
    1,
    2
  ],
  "position_qualification_ids": [
    1,
    2,
    3
  ],
  "custom_attributes": [
    {
      "attribute_id": 11,
      "value": ""
    },
    {
      "attribute_id": 10,
      "value": [
        2,
        3
      ]
    }
  ]
}

HTTP status code 201

Successful response with new member.

Response Body

{} application/json

member_id integer

ID assigned to a member by Aladtec

is_active boolean

Members are either active or inactive

formatted_name string

First and last name of the member

first_name string

Member given name

last_name string

Member family name

login string

Member login name

mobile_phone string

Mobile phone number

primary_email string

Primary email address

secondary_emails array

Email addresses not considered the primary_email

date_hired string

Date the member was hired

employee_type_id integer

ID of the employee type assigned to the member

work_group_id integer

ID of the work group assigned to the member

schedule_ids array

List of schedule IDs the member is qualified to work on

position_qualification_ids array

List of position qualification IDs a member is qualified for

custom_attributes array

Attributes in the Member Database, defined per Aladtec system. Each attribute contains an attribute_id (integer) and a value. The attribute can be Text (string), Date (string), Number (int), Attachment (int), Single Option (array of IDs), or Multi Option (array of IDs).

Example: 

{
  "member_id": 3,
  "is_active": true,
  "formatted_name": "John Smith",
  "first_name": "John",
  "last_name": "Smith",
  "login": "johnsmith",
  "primary_email": "jsmith@company.com",
  "secondary_emails": [
    "jsmith@example.com",
    "jsmith2@example.com"
  ],
  "employee_type_id": 7,
  "work_group_id": 5,
  "date_hired": "2019-01-01",
  "schedule_ids": [
    1,
    2
  ],
  "position_qualification_ids": [
    1,
    2,
    3
  ],
  "custom_attributes": [
    {
      "attribute_id": 11,
      "value": ""
    },
    {
      "attribute_id": 10,
      "value": [
        2,
        3
      ]
    }
  ]
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid payload data.

Response Body

{} application/json

Example: 

[
  {
    "error": "Example error message."
  }
]

<?php 

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v2';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/members';
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));
curl_setopt( $ch, CURLOPT_FAILONERROR, true );

$new_member = array(
	'first_name' => 'John',
	'last_name' => 'Doe',
	'login' => 'johndoe',
	'primary_email' => 'example@email.com',
	'work_group_id' => 1 // Set the ID of the appropriate work group for this new member.
);
curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $new_member ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v2';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

var url = base_url + '/members';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var new_member = {
	first_name: 'John',
	last_name: 'Doe',
	login: 'johndoe',
	primary_email: 'email@example.com',
	work_group_id: 1 // Set the ID of the appropriate work group for this new member.
};
xhr.send( JSON.stringify( new_member ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});
patch

Updates an existing member using a subset of attributes or the entire member.

patch https://secure#.aladtec.com/example/api/v2/members/{member_id}

Description

Updates an existing member using a subset of attributes or the entire member.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

URL Parameters

member_id integer optional ID assigned to a member by Aladtec

Request Body

{} application/json

is_active boolean optional Members are either active or inactive
first_name string optional Member given name
last_name string optional Member family name
login string optional Member login name
mobile_phone string optional Mobile phone number
primary_email string optional Primary email address
secondary_emails array optional Email addresses not considered the primary_email
date_hired string optional Date the member was hired
employee_type_id integer optional ID of the employee type assigned to the member
work_group_id integer optional ID of the work group assigned to the member
schedule_ids array optional List of schedule IDs the member is qualified to work on
position_qualification_ids array optional List of position qualification IDs a member is qualified for
custom_attributes array optional Attributes in the Member Database, defined per Aladtec system. Each attribute contains an attribute_id (integer) and a value. The attribute can be Text (string), Date (string), Number (int), Single Option (array of IDs), or Multi Option (array of IDs). Note: Any attribute IDs or option IDs that are invalid will be ignored and won't be saved.

Example: 

{
  "is_active": true,
  "first_name": "John",
  "last_name": "Smith",
  "login": "johnsmith",
  "primary_email": "jsmith@company.com",
  "secondary_emails": [
    "jsmith@example.com",
    "jsmith2@example.com"
  ],
  "employee_type_id": 7,
  "work_group_id": 5,
  "date_hired": "2019-01-01",
  "schedule_ids": [
    1,
    2
  ],
  "position_qualification_ids": [
    1,
    2,
    3
  ],
  "custom_attributes": [
    {
      "attribute_id": 11,
      "value": ""
    },
    {
      "attribute_id": 10,
      "value": [
        2,
        3
      ]
    }
  ]
}

HTTP status code 200

Successful response with updated member.

Response Body

{} application/json

member_id integer

ID assigned to a member by Aladtec

is_active boolean

Members are either active or inactive

formatted_name string

First and last name of the member

first_name string

Member given name

last_name string

Member family name

login string

Member login name

mobile_phone string

Mobile phone number

primary_email string

Primary email address

secondary_emails array

Email addresses not considered the primary_email

date_hired string

Date the member was hired

employee_type_id integer

ID of the employee type assigned to the member

work_group_id integer

ID of the work group assigned to the member

schedule_ids array

List of schedule IDs the member is qualified to work on

position_qualification_ids array

List of position qualification IDs a member is qualified for

custom_attributes array

Attributes in the Member Database, defined per Aladtec system. Each attribute contains an attribute_id (integer) and a value. The attribute can be Text (string), Date (string), Number (int), Attachment (int), Single Option (array of IDs), or Multi Option (array of IDs).

Example: 

{
  "member_id": 3,
  "is_active": true,
  "formatted_name": "John Smith",
  "first_name": "John",
  "last_name": "Smith",
  "login": "johnsmith",
  "primary_email": "jsmith@company.com",
  "secondary_emails": [
    "jsmith@example.com",
    "jsmith2@example.com"
  ],
  "employee_type_id": 7,
  "work_group_id": 5,
  "date_hired": "2019-01-01",
  "schedule_ids": [
    1,
    2
  ],
  "position_qualification_ids": [
    1,
    2,
    3
  ],
  "custom_attributes": [
    {
      "attribute_id": 11,
      "value": ""
    },
    {
      "attribute_id": 10,
      "value": [
        2,
        3
      ]
    }
  ]
}

HTTP status code 204

Successful response when no changes were saved.

No response content.

HTTP status code 400

Error response containing one or more errors returned as a result of invalid payload data.

Response Body

{} application/json

Example: 

[
  {
    "error": "Example error message."
  }
]

HTTP status code 404

Error response when member ID is not found.

Response Body

{} application/json

Example: 

[
  {
    "error": "Member not found."
  }
]

<?php

/* Set your system URL, API token, and Member ID here. */
$base_url = 'https://secure#.aladtec.com/example/api/v2';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';
$member_id = 2;

$url = $base_url . '/members/' . $member_id;
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'PATCH' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));
curl_setopt( $ch, CURLOPT_FAILONERROR, true );

$update_fields = array(
	'date_hired' => '2019-02-03'
);
curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $update_fields ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v2';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';
var member_id = 2;

var xhr = new XMLHttpRequest();

var url = base_url + '/members/' + member_id;
xhr.open( 'PATCH', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var update_fields = {
	date_hired: '2019-02-03'
};
xhr.send( JSON.stringify( update_fields ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});
get

Returns all employee types. These can be customized per Aladtec system. Examples: part...

get

Returns all customer created Member Database attribute definitions

/availability

Routes for retrieving Member Availability ranges

get

Returns Member Availability for the requested date/time range.

/time-off

Routes for retrieving member Time Off information

get

Approved and pending Time Off ranges for the requested date/time range. Note: By default,...

/schedules

Routes for retrieving Schedule information

get

Schedule configuration defined in an Aladtec system. Data is sorted by the order defined...

get

Returns a list of unique position qualifications.

/scheduled-time

Routes for retrieving scheduled time information

get

Returns scheduled time ranges for a specified period of time

get

Returns time ranges where no member is scheduled. Typically used for finding shifts...

get

Schedule and position for each member scheduled at the time of the request

get

Returns Schedule Notes organized by calendar date. Up to one year can be retrieved in a...

/extra-hours

Routes for retrieving extra hours information

get

Returns extra hours ranges for a specified period of time in the past

/time-clock

Routes for retrieving Time Clock information

get

Returns a list of unique, active Paycodes which can be applied to time clock time.

get

Returns a list of unique, active Kiosks used to clock in and out.

/time-clock-time

Routes for retrieving and updating Time Clock records

get

Time Clock records for the requested date/time range. If a member is clocked in at the...

get

Members clocked in at the time of the request.

post

Clocks a member in given a valid member ID.

post https://secure#.aladtec.com/example/api/v2/time-clock-time/clock-in

Description

Clocks a member in given a valid member ID.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
kiosk_id integer required ID of an authenticated time clock kiosk
clock_in_datetime datetime required Date and time the member is clocking in, format is YYYY-MM-DDTHH:MM. The date and time is limited to up to 5 minutes in the future.
paycode_id integer required ID of an associated paycode, optional if paycodes are turned off in the system.

Example: 

{
  "member_id": 46,
  "kiosk_id": 18,
  "clock_in_datetime": "2021-10-12T07:02",
  "paycode_id": 2
}

HTTP status code 200

Response Body

{} application/json

member_id integer

ID of the Aladtec member clocking into the system

kiosk_id integer

ID of the authenticated kiosk for the member clocking into the system

clock_in_datetime datetime

Date and time the member is clocking in, format is YYYY-MM-DDTHH:MM

paycode_id integer

ID of the paycode for the member clocking into the systems

Example: 

{
  "member_id": 24,
  "kiosk_id": 12,
  "clock_in_datetime": "2021-10-12T07:02",
  "paycode_id": 2
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid payload data

Response Body

{} application/json

Example: 

[
  {
    "error": "Example general error message.",
    "detail": "A more detailed error message."
  }
]

<?php 

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/time-clock-time/clock-in';
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));
curl_setopt( $ch, CURLOPT_FAILONERROR, true );

$clock_in = array(
	'member_id' => 46,
	'kiosk_id' => 18,
	'clock_in_datetime' => '2021-10-12T08:09',
	'paycode_id' => 1
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $clock_in ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

var url = base_url + '/time-clock-time/clock-in';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var clock_in_json = {
	member_id: 46,
	kiosk_id: 18,
	clock_in_datetime: '2021-10-12T07:02',
	paycode_id: 2
};
xhr.send( JSON.stringify( clock_in_json ) );

xhr.addEventListener( "load", function () {
	console.log( xhr.responseText );
});
post

Clocks a member out given a valid member ID.

post https://secure#.aladtec.com/example/api/v2/time-clock-time/clock-out

Description

Clocks a member out given a valid member ID.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
kiosk_id integer required ID of an authenticated time clock kiosk
clock_out_datetime datetime required Date and time the member is clocking out, format is YYYY-MM-DDTHH:MM. The date and time is limited to up to 5 minutes in the future.

Example: 

{
  "member_id": 46,
  "kiosk_id": 18,
  "clock_out_datetime": "2021-10-12T16:15"
}

HTTP status code 200

Response Body

{} application/json

member_id integer

ID of the Aladtec member clocking out of the system

kiosk_id integer

ID of the authenticated kiosk for the member clocking out of the system

clock_out_datetime datetime

Date and time the member is clocking out, format is YYYY-MM-DDTHH:MM

Example: 

{
  "member_id": 24,
  "kiosk_id": 12,
  "clock_out_datetime": "2021-10-12T16:15"
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid payload data

Response Body

{} application/json

Example: 

[
  {
    "error": "Example general error message.",
    "detail": "A more detailed error message."
  }
]

<?php 

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/time-clock-time/clock-out';
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));
curl_setopt( $ch, CURLOPT_FAILONERROR, true );

$clock_out = array(
	'member_id' => 46,
	'kiosk_id' => 18,
	'clock_out_datetime' => '2021-10-12T15:00'
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $clock_out ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

var url = base_url + '/time-clock-time/clock-out';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var clock_out_json = {
	member_id: 46,
	kiosk_id: 18,
	clock_out_datetime: '2021-10-12T16:15'
};
xhr.send( JSON.stringify( clock_out_json ) );

xhr.addEventListener( "load", function () {
	console.log( xhr.responseText );
});

/events

Routes for retrieving Event ranges

get

Events for requested date/time range.

/shift-labels

Routes for retrieving Shift Label information

get

Shift Labels for requested date range.

/work-groups

Routes for retrieving Work Group information

get

Returns all work groups. Work groups are used for putting members into groups if they...

/time-types

Routes for retrieving Time Type information

get

Returns a list of unique Time Types which can be applied to scheduled time.

/accrual-banks

Routes for retrieving and updating Time Off accrual information

get

Returns a list of all accrual banks

get

Returns the number of hours in each specified accrual bank for a list of provided members

put

Sets accrual bank balances given a list of hours for members' accrual banks

post

Updates accrual bank balances given a list of adjustment hours for members' accrual banks

post https://secure#.aladtec.com/example/api/v2/accrual-banks/balances/adjustments

Description

Updates accrual bank balances given a list of adjustment hours for members' accrual banks

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
accrual_bank_id integer required ID assigned to an accrual bank in Aladtec
adjustment_hours number required The relative number of hours to adjust the accrual bank balance. A positive number will increase the balance, and a negative number will decrease the balance. The number can have, at most, four decimal places of precision (e.g. 10.1234).
note string optional An optional note to log details about the adjustment

Example: 

[
  {
    "member_id": 1,
    "accrual_bank_id": 1,
    "adjustment_hours": 24
  },
  {
    "member_id": 1,
    "accrual_bank_id": 2,
    "adjustment_hours": -40,
    "note": 'Example note about the adjustment.'
  },
  {
    "member_id": 3,
    "accrual_bank_id": 2,
    "adjustment_hours": 12.5001
  }
]

HTTP status code 200

Response Body

{} application/json

member_id integer

ID assigned to a member by Aladtec

accrual_bank_id integer

ID assigned to an accrual bank in Aladtec

hours float

The updated number of hours in the bank for the specified member in Aladtec

Example: 

[
  {
	"member_id": 1,
	"accrual_bank_id": 1,
	"hours": 48
  },
  {
	"member_id": 1,
	"accrual_bank_id": 2,
	"hours": -4
  },
  {
	"member_id": 3,
	"accrual_bank_id": 2,
	"hours": 0.5001
  }
]

HTTP status code 400

Error response containing one or more errors returned as a result of invalid payload data. Errors caused by an individual adjustment value also include the member_id and accrual_bank_id to identify that adjustment.

Response Body

{} application/json

Example: 

[
  {
    "error": "Example general error message.",
  },
  {
    "error": "Example error message about a specific adjustment.",
    "member_id": 15,
    "accrual_bank_id": 4
  },
  {
    "error": "Example error message about a specific adjustment.",
    "member_id": 16,
    "accrual_bank_id": 8
  }
]

<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v2';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/accrual-banks/balances/adjustments';
$ch = curl_init( $url );

curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));
curl_setopt( $ch, CURLOPT_FAILONERROR, true );

$accrual_adjustments = array(
	array(
		'member_id' => 1,
		'accrual_bank_id' => 1,
		'adjustment_hours' => 24.000
	),
	array(
		'member_id' => 1,
		'accrual_bank_id' => 2,
		'adjustment_hours' => -40.000,
		'note' => 'Example note about the adjustment.'
	),
	array(
		'member_id' => 3,
		'accrual_bank_id' => 2,
		'adjustment_hours' => 12.5001
	)
);
curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $accrual_adjustments ) );

$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v2';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

var url = base_url + '/accrual-banks/balances/adjustments';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var accrual_adjustments = [
	{
		member_id: 1,
		accrual_bank_id: 1,
		adjustment_hours: 24
	},
	{
		member_id: 1,
		accrual_bank_id: 2,
		adjustment_hours: -40,
		note: 'Example note about the adjustment.'
	},
	{
		member_id: 3,
		accrual_bank_id: 2,
		adjustment_hours: 12.5001
	}
];
xhr.send( JSON.stringify( accrual_adjustments ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});

/configuration

Routes for retrieving Aladtec system configuration information

get

Returns a list of configuration settings

/reports

Routes for exporting reports

get

Runs the Payroll Report export. Pagination is required to export all...