API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve report data from your RQ database (v4.23 and up).

To get started, see Data Connect Guide.

Note

For reports that provide optional URI parameters for filtering at different levels (ForWho/ForWhoIDs/LocationType/LocationTypeIDs), omitting these values will run the report at the default company level.

Authentication

Data Connect supports many different methods of authentication, see Authentication Options.

Note that for all reports the Access Token should be mapped to an employee in RQ.

Report List

For a complete list of reports in Data Connect, see Report List.

ENDPOINTS

RESOURCES

AutoPunchOutReportData

[
    {
        "EmployeeID": 250,
        "Abbreviation": "84WEA",
        "StoreName": "84 West",
        "FirstName": "iQmetrix",
        "LastName": "Employee",
        "PunchInTime": "2015-07-02T12:15:02.45",
        "PunchOutTime": "2015-07-10T13:49:47.457",
        "PunchInComments": ""
    }
]
Name Description
EmployeeID (INT) Internal identifier for an employee in RQ
Abbreviation (VARCHAR(5)) Abbreviation - abbreviation for the location
StoreName (NVARCHAR(MAX)) Location - location where the auto punch was performed
FirstName (VARCHAR(25)) First Name - first name of the employee
LastName (VARCHAR(25)) Last Name - last name of the employee
PunchInTime (DateTime) Punch In - date and time the employee punched in
PunchOutTime (DateTime) Punch Out - if there is a date and time it will be a revised value and it will be blank if the software auto punched out for the employee
PunchInComments (VARCHAR(100)) Punch In Comments - any employee comments

EmployeeListReportData

[
    {
        "Address": "127 starlight lane",
        "Cellular_Number": "5555555555",
        "City": "Fargo",
        "DefaultLocation": null,
        "DefaultZoneForWho": null,
        "Email": "sams@kentel.com",
        "EmailAddress": "sams@kentel.com",
        "Employee_Name": "Sam Smith",
        "ID_Number": 59,
        "IsPartTime": false,
        "Last_Name": "Smith",
        "LastHireDate": "2015-07-03T22:31:05.403",
        "Location": "100: My Network LLC - Anchorage",
        "PersonalEmail": "sam@yopmail.com",
        "Postal_Code": "90123",
        "Province": "ND",
        "RoleDescription": "Sales Representative",
        "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
        "SMS_Number": "5555555555@yopmail.com",
        "SpecialIdentifier": "912345987654321",
        "StartDate": "2010-11-22T10:06:35.133",
        "Status": "Enabled",
        "TerminationDate": "2015-11-22T08:00:25.345",
        "Title": "Wireless Consultant",
        "Username": "Sam.Smith",
        "Work_Number": "5555555555"
    }
]
Name Description
Address (VARCHAR(50)) Address - employee’s address
Cellular_Number (NVARCHAR(MAX)) Cell Phone # - employee’s cell phone number
City (VARCHAR(50)) City - employee’s city
DefaultLocation (INT) Primary Location - primary location if one has been assigned. DefaultLocation and DefaultZoneForWho are used to determine this value
DefaultZoneForWho (TINYINT) Primary Location - primary location if one has been assigned. DefaultLocation and DefaultZoneForWho are used to determine this value
Email (VARCHAR(50)) Email Address - employee’s work email address
EmailAddress (VARCHAR(50)) Email
Employee_Name (VARCHAR(51)) Employee - name of the employee as entered on their employee profile
ID_Number (INT) Internal identifier for employee in RQ
IsPartTime (BIT) Part Time - indicates if an employee is Part Time
Last_Name (VARCHAR(25)) Employee last name
LastHireDate (VARCHAR(50)) Hire Date - day and date the employee was hired
Location (VARCHAR(51)) Location - Only present if Unique is not -1. Every location the employee is assigned to
PersonalEmail (VARCHAR(50)) Personal Email - employee’s personal email address
Postal_Code (VARCHAR(15)) Zip/Postal Code - zip code (USA) or postal code (Canada)
Province (VARCHAR(50)) Province - employee’s province or state
RoleDescription (NVARCHAR(MAX)) Security Role - security role assigned to this employee
ScheduledTerminationDate (DateTime) Scheduled termination date
SMS_Number (VARCHAR(50)) SMS # - employee’s text number
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
StartDate (DateTime) Start Date
Status (VARCHAR(8)) Status - shows if the employee is enabled or disabled if Any Status is selected
TerminationDate (DateTime) Termination Date - date of termination (date the employee was disabled)
Title (VARCHAR(50)) Title - title assigned to this employee
Username (VARCHAR(25)) Username - username of the employee as entered on their employee profile
Work_Number (DateTime) Work Phone # - employee’s work number

TimeAndAttendanceReportData

[
    {
        "DoubleOTClockedMinutes": 0,
        "DoubleOTScheduleMinutes": 0,
        "EmployeeCompensationType": "3",
        "EmployeeGroup": "100% (35% GP)",
        "EmployeeID": 186,
        "EmployeeLastName": "Smith",
        "EmployeeName": "Brooke Smith",
        "EmployeeUsername": "Brooke.Smith",
        "IsPartTime": "0",
        "ManagerVerified": 0,
        "OTClockedMinutes": 0,
        "OTScheduleMinutes": 105,
        "PartTimeVacationEarned": 0,
        "PersonalUsedHours": 0,
        "PT_DoubleOTVacationEarned": 0,
        "PT_OTVacationEarned": 0,
        "SickUsedHours": 0,
        "SpecialIdentifier": "912345987654321",
        "SupervisorName": "Bob Roberts",
        "SupervisorUsername": "Bob.Roberts",
        "ThresholdConflict": 0,
        "Title": "Store Clerk",
        "TotalClockedMinutes": 0,
        "TotalScheduleMinutes": 105,
        "VacationUsedHours": 0
    }
]
Name Description
DoubleOTClockedMinutes (INT) Double OT Clocked - total of double overtime hours calculated, calculated using decimal time rather than hours:minutes
DoubleOTScheduleMinutes (INT) Double OT Scheduled - total of double overtime hours scheduled, calculated using decimal time rather than hours:minutes
EmployeeCompensationType (VARCHAR(50)) Compensation - type of compensation for the employee
EmployeeGroup (VARCHAR(50)) Commission - type of commission for the employee
EmployeeID (INT) Identifier for an Employee in RQ
EmployeeLastName (VARCHAR(25)) Employee last name
EmployeeName (VARCHAR(51)) Employee - any employee who was scheduled to work or punched in within in the report’s criteria
EmployeeUsername (VARCHAR(51)) Username - username of the employee who was scheduled to work or punched in within in the report’s criteria
IsPartTime (VARCHAR(50)) Part Time - a check box indicating if an employee is Part Time
ManagerVerified (TINYINT) Internal flag used in RQ
OTClockedMinutes (INT) Overtime Clocked - total of overtime hours clocked, calculated using decimal time rather than hours:minutes
OTScheduleMinutes (INT) Overtime Scheduled - total of overtime hours scheduled, calculated using decimal time rather than hours:minutes
PartTimeVacationEarned (DECIMAL) PT Vacation Earned - total amount of part time vacation earned, calculated using decimal time rather than hours:minutes
PersonalUsedHours (DECIMAL) Personal Used - total amount of personal days used, calculated using decimal time rather than hours:minutes
PT_DoubleOTVacationEarned (DECIMAL) Double OT Vacation - total amount of Double OT vacation earned, calculated using decimal time rather than hours:minutes
PT_OTVacationEarned (DECIMAL) OT Vacation Earned - total amount of OT vacation earned, calculated using decimal time rather than hours:minutes
SickUsedHours (DECIMAL) Sick Used - total amount of sick time used, calculated using decimal time rather than hours:minutes
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
SupervisorName (VARCHAR(51)) Supervisor - name of the employee’s supervisor
SupervisorUsername (VARCHAR(51)) Supervisor Username - username of the name of the employee’s supervisor
ThresholdConflict (INT) A flag to indicate if the employee is working in multiple locations that have different work weeks or OT parameters, highlighted in red in the report
Title (VARCHAR(50)) Title - title assigned to this employee
TotalClockedMinutes (INT) Total Clocked - total of all hours clocked, calculated using decimal time rather than hours:minutes
TotalScheduleMinutes (INT) Total Scheduled - total of all hours scheduled, calculated using decimal time rather than hours:minutes
VacationUsedHours (DECIMAL) Vacation Used - total of amount of vacation used, calculated using decimal time rather than hours:minutes

REQUESTS

GET the Auto Punch Out Report

For more information see Auto Punch Out Report.

Definition

GET /reports/AutoPunchOutReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/AutoPunchOutReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/AutoPunchOutReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheAutoPunchOutReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/AutoPunchOutReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheAutoPunchOutReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/AutoPunchOutReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/AutoPunchOutReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[AutoPunchOutReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeID": 250,
        "Abbreviation": "84WEA",
        "StoreName": "84 West",
        "FirstName": "iQmetrix",
        "LastName": "Employee",
        "PunchInTime": "2015-07-02T12:15:02.45",
        "PunchOutTime": "2015-07-10T13:49:47.457",
        "PunchInComments": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeID": 250,
            "Abbreviation": "84WEA",
            "StoreName": "84 West",
            "FirstName": "iQmetrix",
            "LastName": "Employee",
            "PunchInTime": "2015-07-02T12:15:02.45",
            "PunchOutTime": "2015-07-10T13:49:47.457",
            "PunchInComments": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeID>250</EmployeeID>
    <Abbreviation>84WEA</Abbreviation>
    <StoreName>84 West</StoreName>
    <FirstName>iQmetrix</FirstName>
    <LastName>Employee</LastName>
    <PunchInTime>2015-07-02T12:15:02.45</PunchInTime>
    <PunchOutTime>2015-07-10T13:49:47.457</PunchOutTime>
    <PunchInComments></PunchInComments>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
EmployeeID,Abbreviation,StoreName,FirstName,LastName,PunchInTime,PunchOutTime,PunchInComments
250,84WEA,84 West,iQmetrix,Employee,2015-07-02T12:15:02.45,2015-07-10T13:49:47.457,

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Employee List Report

For more information, see Employee List Report.

Definition

GET /reports/employeelistreport?Status={Status}&Unique={Unique}&GroupID={GroupID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/employeelistreport?Status=1&Unique=false&GroupID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/employeelistreport?Status=1&Unique=false&GroupID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheEmployeeListReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/employeelistreport?Status=1&Unique=false&GroupID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheEmployeeListReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/employeelistreport?Status=1&Unique=false&GroupID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/employeelistreport?Status=1&Unique=false&GroupID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EmployeeListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Address": "127 starlight lane",
        "Cellular_Number": "5555555555",
        "City": "Fargo",
        "DefaultLocation": null,
        "DefaultZoneForWho": null,
        "Email": "sams@kentel.com",
        "EmailAddress": "sams@kentel.com",
        "Employee_Name": "Sam Smith",
        "ID_Number": 59,
        "IsPartTime": false,
        "Last_Name": "Smith",
        "LastHireDate": "2015-07-03T22:31:05.403",
        "Location": "100: My Network LLC - Anchorage",
        "PersonalEmail": "sam@yopmail.com",
        "Postal_Code": "90123",
        "Province": "ND",
        "RoleDescription": "Sales Representative",
        "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
        "SMS_Number": "5555555555@yopmail.com",
        "SpecialIdentifier": "912345987654321",
        "StartDate": "2010-11-22T10:06:35.133",
        "Status": "Enabled",
        "TerminationDate": "2015-11-22T08:00:25.345",
        "Title": "Wireless Consultant",
        "Username": "Sam.Smith",
        "Work_Number": "5555555555"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Address": "127 starlight lane",
            "Cellular_Number": "5555555555",
            "City": "Fargo",
            "DefaultLocation": null,
            "DefaultZoneForWho": null,
            "Email": "sams@kentel.com",
            "EmailAddress": "sams@kentel.com",
            "Employee_Name": "Sam Smith",
            "ID_Number": 59,
            "IsPartTime": false,
            "Last_Name": "Smith",
            "LastHireDate": "2015-07-03T22:31:05.403",
            "Location": "100: My Network LLC - Anchorage",
            "PersonalEmail": "sam@yopmail.com",
            "Postal_Code": "90123",
            "Province": "ND",
            "RoleDescription": "Sales Representative",
            "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
            "SMS_Number": "5555555555@yopmail.com",
            "SpecialIdentifier": "912345987654321",
            "StartDate": "2010-11-22T10:06:35.133",
            "Status": "Enabled",
            "TerminationDate": "2015-11-22T08:00:25.345",
            "Title": "Wireless Consultant",
            "Username": "Sam.Smith",
            "Work_Number": "5555555555"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Address>127 starlight lane</Address>
    <Cellular_Number>5555555555</Cellular_Number>
    <City>Fargo</City>
    <DefaultLocation>null</DefaultLocation>
    <DefaultZoneForWho>null</DefaultZoneForWho>
    <Email>sams@kentel.com</Email>
    <EmailAddress>sams@kentel.com</EmailAddress>
    <Employee_Name>Sam Smith</Employee_Name>
    <ID_Number>59</ID_Number>
    <IsPartTime>false</IsPartTime>
    <Last_Name>Smith</Last_Name>
    <LastHireDate>2015-07-03T22:31:05.403</LastHireDate>
    <Location>100: My Network LLC - Anchorage</Location>
    <PersonalEmail>sam@yopmail.com</PersonalEmail>
    <Postal_Code>90123</Postal_Code>
    <Province>ND</Province>
    <RoleDescription>Sales Representative</RoleDescription>
    <ScheduledTerminationDate>2015-11-22T08:00:00.000</ScheduledTerminationDate>
    <SMS_Number>5555555555@yopmail.com</SMS_Number>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <StartDate>2010-11-22T10:06:35.133</StartDate>
    <Status>Enabled</Status>
    <TerminationDate>2015-11-22T08:00:25.345</TerminationDate>
    <Title>Wireless Consultant</Title>
    <Username>Sam.Smith</Username>
    <Work_Number>5555555555</Work_Number>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Address,Cellular_Number,City,DefaultLocation,DefaultZoneForWho,Email,EmailAddress,Employee_Name,ID_Number,IsPartTime,Last_Name,LastHireDate,Location,PersonalEmail,Postal_Code,Province,RoleDescription,ScheduledTerminationDate,SMS_Number,SpecialIdentifier,StartDate,Status,TerminationDate,Title,Username,Work_Number
127 starlight lane,5555555555,Fargo,null,null,sams@kentel.com,sams@kentel.com,Sam Smith,59,false,Smith,2015-07-03T22:31:05.403,100: My Network LLC - Anchorage,sam@yopmail.com,90123,ND,Sales Representative,2015-11-22T08:00:00.000,5555555555@yopmail.com,912345987654321,2010-11-22T10:06:35.133,Enabled,2015-11-22T08:00:25.345,Wireless Consultant,Sam.Smith,5555555555

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Time and Attendance Report

For more information, see Time And Attendance Report.

Definition

GET /reports/timeandattendancereport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/timeandattendancereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/timeandattendancereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheTimeAndAttendanceReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/timeandattendancereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheTimeAndAttendanceReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/timeandattendancereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/timeandattendancereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[TimeAndAttendanceReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DoubleOTClockedMinutes": 0,
        "DoubleOTScheduleMinutes": 0,
        "EmployeeCompensationType": "3",
        "EmployeeGroup": "100% (35% GP)",
        "EmployeeID": 186,
        "EmployeeLastName": "Smith",
        "EmployeeName": "Brooke Smith",
        "EmployeeUsername": "Brooke.Smith",
        "IsPartTime": "0",
        "ManagerVerified": 0,
        "OTClockedMinutes": 0,
        "OTScheduleMinutes": 105,
        "PartTimeVacationEarned": 0,
        "PersonalUsedHours": 0,
        "PT_DoubleOTVacationEarned": 0,
        "PT_OTVacationEarned": 0,
        "SickUsedHours": 0,
        "SpecialIdentifier": "912345987654321",
        "SupervisorName": "Bob Roberts",
        "SupervisorUsername": "Bob.Roberts",
        "ThresholdConflict": 0,
        "Title": "Store Clerk",
        "TotalClockedMinutes": 0,
        "TotalScheduleMinutes": 105,
        "VacationUsedHours": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DoubleOTClockedMinutes": 0,
            "DoubleOTScheduleMinutes": 0,
            "EmployeeCompensationType": "3",
            "EmployeeGroup": "100% (35% GP)",
            "EmployeeID": 186,
            "EmployeeLastName": "Smith",
            "EmployeeName": "Brooke Smith",
            "EmployeeUsername": "Brooke.Smith",
            "IsPartTime": "0",
            "ManagerVerified": 0,
            "OTClockedMinutes": 0,
            "OTScheduleMinutes": 105,
            "PartTimeVacationEarned": 0,
            "PersonalUsedHours": 0,
            "PT_DoubleOTVacationEarned": 0,
            "PT_OTVacationEarned": 0,
            "SickUsedHours": 0,
            "SpecialIdentifier": "912345987654321",
            "SupervisorName": "Bob Roberts",
            "SupervisorUsername": "Bob.Roberts",
            "ThresholdConflict": 0,
            "Title": "Store Clerk",
            "TotalClockedMinutes": 0,
            "TotalScheduleMinutes": 105,
            "VacationUsedHours": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DoubleOTClockedMinutes>0</DoubleOTClockedMinutes>
    <DoubleOTScheduleMinutes>0</DoubleOTScheduleMinutes>
    <EmployeeCompensationType>3</EmployeeCompensationType>
    <EmployeeGroup>100% (35% GP)</EmployeeGroup>
    <EmployeeID>186</EmployeeID>
    <EmployeeLastName>Smith</EmployeeLastName>
    <EmployeeName>Brooke Smith</EmployeeName>
    <EmployeeUsername>Brooke.Smith</EmployeeUsername>
    <IsPartTime>0</IsPartTime>
    <ManagerVerified>0</ManagerVerified>
    <OTClockedMinutes>0</OTClockedMinutes>
    <OTScheduleMinutes>105</OTScheduleMinutes>
    <PartTimeVacationEarned>0</PartTimeVacationEarned>
    <PersonalUsedHours>0</PersonalUsedHours>
    <PT_DoubleOTVacationEarned>0</PT_DoubleOTVacationEarned>
    <PT_OTVacationEarned>0</PT_OTVacationEarned>
    <SickUsedHours>0</SickUsedHours>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <SupervisorName>Bob Roberts</SupervisorName>
    <SupervisorUsername>Bob.Roberts</SupervisorUsername>
    <ThresholdConflict>0</ThresholdConflict>
    <Title>Store Clerk</Title>
    <TotalClockedMinutes>0</TotalClockedMinutes>
    <TotalScheduleMinutes>105</TotalScheduleMinutes>
    <VacationUsedHours>0</VacationUsedHours>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
DoubleOTClockedMinutes,DoubleOTScheduleMinutes,EmployeeCompensationType,EmployeeGroup,EmployeeID,EmployeeLastName,EmployeeName,EmployeeUsername,IsPartTime,ManagerVerified,OTClockedMinutes,OTScheduleMinutes,PartTimeVacationEarned,PersonalUsedHours,PT_DoubleOTVacationEarned,PT_OTVacationEarned,SickUsedHours,SpecialIdentifier,SupervisorName,SupervisorUsername,ThresholdConflict,Title,TotalClockedMinutes,TotalScheduleMinutes,VacationUsedHours
0,0,3,100% (35% GP),186,Smith,Brooke Smith,Brooke.Smith,0,0,0,105,0,0,0,0,0,912345987654321,Bob Roberts,Bob.Roberts,0,Store Clerk,0,105,0

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Tokan is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
Was this page helpful?