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

EmployeePayrollReportData

[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix",
        "Last_Name": "Employee",
        "SpecialIdentifier": "912345987654321",
        "IsPartTime": "0",
        "EmployeeID": 1315,
        "StoreName": "84 West",
        "StoreID": 1,
        "ManagerApproved": 0,
        "TotalClockedMinutes": 0,
        "OTClockedMinutes": 0,
        "DoubleOTClockedMinutes": 0,
        "TotalScheduleMinutes": 240,
        "PartTimeVacationEarned": 0,
        "VacationUsedHours": 0,
        "SickUsedHours": 0,
        "PersonalUsedHours": 0,
        "ThresholdConflict": "29 300 2100 480 180 600 -1 -1 -1",
        "SupervisorName": "",
        "EmployeeGroup": "100% (35% GP)",
        "EmployeeCompensationType": "0",
        "EmployeeCompensationfrequency": 0,
        "EmployeeCompensationRate": 0,
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "DefaultLocation": -1
    }
]
Name Description
EmployeeName (VARCHAR(51)) Employee - all employees with scheduled or punched times that fall within the search criteria
EmployeeUsername (VARCHAR(51)) Username - username of the employee
Last_Name (VARCHAR(25)) Last name
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
IsPartTime (VARCHAR(50)) Part Time - indicates if this is a part time employee
EmployeeID (INT) Internal identifier for an Employee in RQ
StoreName (VARCHAR(150)) Location - location where the employee was scheduled or had punched times
StoreID (INT) Internal identifier for a Store in RQ
ManagerApproved (TINYINT)  
TotalClockedMinutes (INT) Total Clocked -total of all hours clocked, calculated using decimal time rather than hours:minutes
OTClockedMinutes (INT) Overtime Clocked - overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
DoubleOTClockedMinutes (INT) Double OT Clocked - double overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
TotalScheduleMinutes (INT) Scheduled - hours that the employee was scheduled to work, 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
VacationUsedHours (DECIMAL) Vacation Used - total amount of vacation time used
SickUsedHours (DECIMAL) Sick Used - total amount of sick time used
PersonalUsedHours (DECIMAL) Personal Used - total amount of personal time used
ThresholdConflict (VARCHAR(100)) Total Variance - total of the difference between scheduled and actual hours clocked using decimal time rather than hours:minutes
SupervisorName (VARCHAR(51)) Supervisor - supervisor for the employee
EmployeeGroup (VARCHAR(50)) Commission - commission group for the employee
EmployeeCompensationType (VARCHAR(50)) Compensation - compensation type for the employee
EmployeeCompensationfrequency (INT) Interval - compensation interval for the employee
EmployeeCompensationRate (MONEY) Rate - compensation rate for the employee
DistrictName (VARCHAR(150)) District - district the employee is assigned to
RegionName (VARCHAR(150)) Region - region the employee is assigned to
ChannelName (VARCHAR(150)) Channel - channel the employee is assigned to
DefaultLocation (INT)  

LocationPayrollReportData

[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "Last_Name": "Employee",
        "SpecialIdentifier": "912345987654321",
        "IsPartTime": "0",
        "EmployeeID": 249,
        "StoreName": "100: My Network LLC - Anchorage",
        "StoreID": 6679,
        "ManagerApproved": 0,
        "TotalClockedMinutes": 0,
        "OTClockedMinutes": 0,
        "DoubleOTClockedMinutes": 0,
        "TotalScheduleMinutes": 240,
        "PartTimeVacationEarned": 0,
        "VacationUsedHours": 0,
        "SickUsedHours": 0,
        "PersonalUsedHours": 0,
        "ThresholdConflict": "-1 0 0 0 0 0 0 0 0",
        "SupervisorName": "",
        "EmployeeGroup": "Group",
        "EmployeeCompensationType": "5",
        "EmployeeCompensationfrequency": 0,
        "EmployeeCompensationRate": 0,
        "DistrictName": "Westminster",
        "RegionName": "London",
        "ChannelName": "English Channel",
        "DefaultLocation": 13
    }
]
Name Description
EmployeeName (VARCHAR(51)) Employee - all employees with scheduled or punched times that fall within the search criteria. The name will appear red if shifts from that location have not been approved.
EmployeeUsername (VARCHAR(51)) Username - user name of the employee as set up in the employee profile
Last_Name (VARCHAR(25)) Last name
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
IsPartTime (VARCHAR(50)) Part Time - a check box indicating if an employee is Part Time
EmployeeID (INT) Internal identifier for an Employee in RQ
StoreName (VARCHAR(150)) Location - location where the employee was scheduled or had punched times
StoreID (INT) Internal identifier for a Store in RQ
ManagerApproved (TINYINT)  
TotalClockedMinutes (INT) Total Clocked - total of all hours clocked, calculated using decimal time rather than hours:minutes
OTClockedMinutes (INT) Overtime Clocked - overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
DoubleOTClockedMinutes (INT) Double OT Clocked - double overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
TotalScheduleMinutes (INT) Scheduled - hours that the employee was scheduled to work, 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
VacationUsedHours (DECIMAL) Vacation Used - total amount of vacation time used
SickUsedHours (DECIMAL) Sick Used - total amount of sick time used
PersonalUsedHours (DECIMAL) Personal Used - total amount of personal time used
ThresholdConflict (VARCHAR(100)) Total Variance - difference between all scheduled and clocked hours, calculated using decimal time rather than hours:minutes
SupervisorName (VARCHAR(51)) Supervisor - name of the employee’s supervisor
EmployeeGroup (VARCHAR(50)) Commission - type of commission for the employee
EmployeeCompensationType (VARCHAR(50)) Compensation - type of compensation for the employee
EmployeeCompensationfrequency (INT) Interval - how often the employee receives commission
EmployeeCompensationRate (MONEY) Rate - rate of compensation for the employee
DistrictName (VARCHAR(150)) District - district the location is listed under
RegionName (VARCHAR(150)) Region - region the location is listed under
ChannelName (VARCHAR(150)) Channel - channel the location is listed under
DefaultLocation (INT)  

ManagerOverrideReportData

[
    {
        "SecurityCode": "DISCOUNT",
        "SecurityOverrideTypeID": 11,
        "LocationID": 21,
        "StoreName": "84 West",
        "RequestedBy": "iQmetrix Employee",
        "RequestedByID": 221,
        "GeneratedBy": "iQmetrix Employee",
        "GeneratedByID": 221,
        "UsedBy": "iQmetrix Employee",
        "UsedByID": 221,
        "CreatedDate": "2015-01-07T14:46:08.87",
        "ExpiryDate": "2015-01-30T14:46:08.87",
        "AppliedDate": "2015-01-07T14:46:08.87",
        "InvoiceID": 122081,
        "Invoice": "REDSTIN401",
        "CustomerID": -1,
        "Customer": "No Customer",
        "Comments": "Vacation",
        "RecordType": 2,
        "AuthType": 2
    }
]
Name Description
SecurityCode (VARCHAR(8)) Code - discount code used
SecurityOverrideTypeID (TINYINT) Internal identifier in RQ
LocationID (INT) Identifier for a Store in RQ
StoreName (NVARCHAR(MAX)) Location - location which applied the override
RequestedBy (VARCHAR(255)) Requested By - name of the employee who requested the override
RequestedByID (INT) Identifier fnr an employee in RQ
GeneratedBy (VARCHAR(255)) Authorized By - name of the employee who authorized the override
GeneratedByID (INT) Identifier for an Employee in RQ
UsedBy (VARCHAR(255)) Applied By - name of the employee who applied the override
UsedByID (INT) Identifier for an Employee in RQ
CreatedDate (DateTime) Date/Time - date and time the override was applied
ExpiryDate (DateTime) Expiration date
AppliedDate (DateTime) Applied date
InvoiceID (INT) Identifier for an Invoice in RQ
Invoice (VARCHAR(14)) Invoice - invoice number, if applied to an invoice
CustomerID (INT) Identifier for a Customer in RQ
Customer (VARCHAR(151)) Customer - customer name, if applied to an invoice
Comments (NVARCHAR(MAX)) Comments - invoice comments, if any
RecordType (INT) Type - type of override
AuthType (TINYINT) Auth Type - this will indicate how the override was done (password, fingerprint, etc.)

ManagerTimeSheetApprovalReportData

[
    {
        "HRDate": "2015-03-30T00:00:00",
        "TotalClockedHours": 1,
        "EmployeeID": 2319,
        "EmployeeName": "James Smith",
        "EmployeeUsername": "james.smith",
        "SpecialIdentifier": "912345987654321",
        "MaxLastName": "Smith",
        "StoreID": 13,
        "StoreName": "Corporate Office",
        "DistrictName": "I-10 Area",
        "RegionName": "Florida",
        "ChannelName": "First Channel",
        "SupervisorName": "Adam West",
        "SupervisorUsername": "Adam.West",
        "EmployeeGroup": "100% (35% GP)",
        "DistrictID": 2,
        "RegionID": 2,
        "EmployeeVerified": 0,
        "ManagerVerified": 0,
        "OTClockedHours": 0,
        "DoubleOTClockedHours": 0,
        "ScheduledHours": 0,
        "Revised": 1,
        "ThresholdConflict": "29 -1 2400 -1 -1 -1 -1 -1 -1",
        "EmployeeCompensationType": 0
    }
]
Name Description
HRDate (DateTime) Date - work date
TotalClockedHours (DECIMAL) Total - total of all hours clocked, calculated using decimal time rather than hours:minutes
EmployeeID (INT) Identifier for an Employee in RQ
EmployeeName (VARCHAR(51)) Employee - all employees with scheduled or punched times that fall within the search criteria, includes the employee username in parentheses
EmployeeUsername (VARCHAR(51)) Employee user name
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
MaxLastName (VARCHAR(25)) Last name
StoreID (INT) Identifier for a Store in RQ
StoreName (NVARCHAR(MAX)) Location - location where the employee was scheduled or had punched times
DistrictName (NVARCHAR(MAX)) District - district the employee is assigned to
RegionName (NVARCHAR(MAX)) Region - region the employee is assigned to
ChannelName (NVARCHAR(MAX)) Channel - channel the employee is assigned to [may not display depending on channel settings]
SupervisorName (VARCHAR(50)) Supervisor - name of the employee’s supervisor
SupervisorUsername (VARCHAR(51)) Supervisor Username - username of the name of the employee’s supervisor
EmployeeGroup (VARCHAR(50)) Commission - type of commission for the employee
DistrictID (INT) Identifier for a District in RQ
RegionID (INT) Identifier for a Region in RQ
EmployeeVerified (INT) Emp. Approved - indicates if the employee has reviewed and approved his or her punches
ManagerVerified (INT) Mgmt Approved - checkbox for managers to approve each day’s hours, the Approve All button is available to approve all punches in the report range
OTClockedHours (DECIMAL) Overtime - overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
DoubleOTClockedHours (DECIMAL) Double OT - double overtime hours that the employee actually worked, calculated using decimal time rather than hours:minutes
ScheduledHours (DECIMAL) Scheduled - hours that the employee was scheduled to work, calculated using decimal time rather than hours:minutes
Revised (INT) Internal value in RQ
ThresholdConflict (VARCHAR(200)) Total Variance - net total of the difference between scheduled and actual worked hours
EmployeeCompensationType (INT) Compensation - type of compensation for the employee

RequestedTimeOffReportData

[
    {
        "RequestID": 5,
        "EmployeeID": 19,
        "EmployeeName": "iQmetrix Employee",
        "Username": "iQmetrix.Employee",
        "EmployeeLastName": "Armstrong",
        "SpecialIdentifier": "912345987654321",
        "Role": "Sales Representative",
        "Title": "ZHello Title!",
        "ManagerName": "Trey Fowler",
        "Type": 1,
        "Status": 2,
        "DateFrom": "2011-03-25T09:00:00",
        "DateTo": "2011-03-25T19:00:00",
        "DaysRequested": 1,
        "Notes": "taking off for wedding",
        "ManagerNotes": "",
        "Paid": false,
        "PaidNotes": ""
    }
]
Name Description
RequestID (INT) Identifier for an RTO in RQ
EmployeeID (INT) Identifier for an Employee in RQ
EmployeeName (VARCHAR(51)) Employee - employee who has time off within in the report’s criteria
Username (VARCHAR(51)) Username - username of the employee who has time off within in the report’s criteria
EmployeeLastName (VARCHAR(25)) Employee last name
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
Role (VARCHAR(50)) Role - as assigned in the employee’s profile
Title (VARCHAR(50)) Title - as assigned in the employee’s profile
ManagerName (VARCHAR(51)) Manager - employee who approved or declined the time off
Type (TINYINT) Type - Pending, Approved or Declined
Status (TINYINT) Status - Pending, Approved or Declined
DateFrom (DateTime) Started On - date and time the time off began
DateTo (DateTime) Ended On - date and time the time off ended
DaysRequested (DECIMAL) Days Requested - this will state the number of days requested
Notes (VARCHAR(255)) Employee Comments - any comments the employee included with the request
ManagerNotes (VARCHAR(255)) Manager Comments - any comments the manager made
Paid (BIT) Paid In Full - this is an information only box used to note the employee has been paid
PaidNotes (VARCHAR(255)) Payment Comments - any comments regarding paymen

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 Payroll Report

For more information, see Employee Payroll Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/EmployeePayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByEmployees" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheEmployeePayrollReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/EmployeePayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByEmployees");
    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 GettingTheEmployeePayrollReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/EmployeePayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByEmployees");
     
    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/EmployeePayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByEmployees', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EmployeePayrollReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix",
        "Last_Name": "Employee",
        "SpecialIdentifier": "912345987654321",
        "IsPartTime": "0",
        "EmployeeID": 1315,
        "StoreName": "84 West",
        "StoreID": 1,
        "ManagerApproved": 0,
        "TotalClockedMinutes": 0,
        "OTClockedMinutes": 0,
        "DoubleOTClockedMinutes": 0,
        "TotalScheduleMinutes": 240,
        "PartTimeVacationEarned": 0,
        "VacationUsedHours": 0,
        "SickUsedHours": 0,
        "PersonalUsedHours": 0,
        "ThresholdConflict": "29 300 2100 480 180 600 -1 -1 -1",
        "SupervisorName": "",
        "EmployeeGroup": "100% (35% GP)",
        "EmployeeCompensationType": "0",
        "EmployeeCompensationfrequency": 0,
        "EmployeeCompensationRate": 0,
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "DefaultLocation": -1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeName": "iQmetrix Employee",
            "EmployeeUsername": "iQmetrix",
            "Last_Name": "Employee",
            "SpecialIdentifier": "912345987654321",
            "IsPartTime": "0",
            "EmployeeID": 1315,
            "StoreName": "84 West",
            "StoreID": 1,
            "ManagerApproved": 0,
            "TotalClockedMinutes": 0,
            "OTClockedMinutes": 0,
            "DoubleOTClockedMinutes": 0,
            "TotalScheduleMinutes": 240,
            "PartTimeVacationEarned": 0,
            "VacationUsedHours": 0,
            "SickUsedHours": 0,
            "PersonalUsedHours": 0,
            "ThresholdConflict": "29 300 2100 480 180 600 -1 -1 -1",
            "SupervisorName": "",
            "EmployeeGroup": "100% (35% GP)",
            "EmployeeCompensationType": "0",
            "EmployeeCompensationfrequency": 0,
            "EmployeeCompensationRate": 0,
            "DistrictName": "Valley Area District",
            "RegionName": "Region A",
            "ChannelName": "Regina Channel",
            "DefaultLocation": -1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeUsername>iQmetrix</EmployeeUsername>
    <Last_Name>Employee</Last_Name>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <IsPartTime>0</IsPartTime>
    <EmployeeID>1315</EmployeeID>
    <StoreName>84 West</StoreName>
    <StoreID>1</StoreID>
    <ManagerApproved>0</ManagerApproved>
    <TotalClockedMinutes>0</TotalClockedMinutes>
    <OTClockedMinutes>0</OTClockedMinutes>
    <DoubleOTClockedMinutes>0</DoubleOTClockedMinutes>
    <TotalScheduleMinutes>240</TotalScheduleMinutes>
    <PartTimeVacationEarned>0</PartTimeVacationEarned>
    <VacationUsedHours>0</VacationUsedHours>
    <SickUsedHours>0</SickUsedHours>
    <PersonalUsedHours>0</PersonalUsedHours>
    <ThresholdConflict>29 300 2100 480 180 600 -1 -1 -1</ThresholdConflict>
    <SupervisorName></SupervisorName>
    <EmployeeGroup>100% (35% GP)</EmployeeGroup>
    <EmployeeCompensationType>0</EmployeeCompensationType>
    <EmployeeCompensationfrequency>0</EmployeeCompensationfrequency>
    <EmployeeCompensationRate>0</EmployeeCompensationRate>
    <DistrictName>Valley Area District</DistrictName>
    <RegionName>Region A</RegionName>
    <ChannelName>Regina Channel</ChannelName>
    <DefaultLocation>-1</DefaultLocation>
  </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
EmployeeName,EmployeeUsername,Last_Name,SpecialIdentifier,IsPartTime,EmployeeID,StoreName,StoreID,ManagerApproved,TotalClockedMinutes,OTClockedMinutes,DoubleOTClockedMinutes,TotalScheduleMinutes,PartTimeVacationEarned,VacationUsedHours,SickUsedHours,PersonalUsedHours,ThresholdConflict,SupervisorName,EmployeeGroup,EmployeeCompensationType,EmployeeCompensationfrequency,EmployeeCompensationRate,DistrictName,RegionName,ChannelName,DefaultLocation
iQmetrix Employee,iQmetrix,Employee,912345987654321,0,1315,84 West,1,0,0,0,0,240,0,0,0,0,29 300 2100 480 180 600 -1 -1 -1,,100% (35% GP),0,0,0,Valley Area District,Region A,Regina Channel,-1

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 Location Payroll Report

For more information, see Location Payroll Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/LocationPayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByStores" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheLocationPayrollReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/LocationPayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByStores");
    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 GettingTheLocationPayrollReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/LocationPayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByStores");
     
    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/LocationPayrollReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&OrderBy=ByStores', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[LocationPayrollReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "Last_Name": "Employee",
        "SpecialIdentifier": "912345987654321",
        "IsPartTime": "0",
        "EmployeeID": 249,
        "StoreName": "100: My Network LLC - Anchorage",
        "StoreID": 6679,
        "ManagerApproved": 0,
        "TotalClockedMinutes": 0,
        "OTClockedMinutes": 0,
        "DoubleOTClockedMinutes": 0,
        "TotalScheduleMinutes": 240,
        "PartTimeVacationEarned": 0,
        "VacationUsedHours": 0,
        "SickUsedHours": 0,
        "PersonalUsedHours": 0,
        "ThresholdConflict": "-1 0 0 0 0 0 0 0 0",
        "SupervisorName": "",
        "EmployeeGroup": "Group",
        "EmployeeCompensationType": "5",
        "EmployeeCompensationfrequency": 0,
        "EmployeeCompensationRate": 0,
        "DistrictName": "Westminster",
        "RegionName": "London",
        "ChannelName": "English Channel",
        "DefaultLocation": 13
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeName": "iQmetrix Employee",
            "EmployeeUsername": "iQmetrix.Employee",
            "Last_Name": "Employee",
            "SpecialIdentifier": "912345987654321",
            "IsPartTime": "0",
            "EmployeeID": 249,
            "StoreName": "100: My Network LLC - Anchorage",
            "StoreID": 6679,
            "ManagerApproved": 0,
            "TotalClockedMinutes": 0,
            "OTClockedMinutes": 0,
            "DoubleOTClockedMinutes": 0,
            "TotalScheduleMinutes": 240,
            "PartTimeVacationEarned": 0,
            "VacationUsedHours": 0,
            "SickUsedHours": 0,
            "PersonalUsedHours": 0,
            "ThresholdConflict": "-1 0 0 0 0 0 0 0 0",
            "SupervisorName": "",
            "EmployeeGroup": "Group",
            "EmployeeCompensationType": "5",
            "EmployeeCompensationfrequency": 0,
            "EmployeeCompensationRate": 0,
            "DistrictName": "Westminster",
            "RegionName": "London",
            "ChannelName": "English Channel",
            "DefaultLocation": 13
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeUsername>iQmetrix.Employee</EmployeeUsername>
    <Last_Name>Employee</Last_Name>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <IsPartTime>0</IsPartTime>
    <EmployeeID>249</EmployeeID>
    <StoreName>100: My Network LLC - Anchorage</StoreName>
    <StoreID>6679</StoreID>
    <ManagerApproved>0</ManagerApproved>
    <TotalClockedMinutes>0</TotalClockedMinutes>
    <OTClockedMinutes>0</OTClockedMinutes>
    <DoubleOTClockedMinutes>0</DoubleOTClockedMinutes>
    <TotalScheduleMinutes>240</TotalScheduleMinutes>
    <PartTimeVacationEarned>0</PartTimeVacationEarned>
    <VacationUsedHours>0</VacationUsedHours>
    <SickUsedHours>0</SickUsedHours>
    <PersonalUsedHours>0</PersonalUsedHours>
    <ThresholdConflict>-1 0 0 0 0 0 0 0 0</ThresholdConflict>
    <SupervisorName></SupervisorName>
    <EmployeeGroup>Group</EmployeeGroup>
    <EmployeeCompensationType>5</EmployeeCompensationType>
    <EmployeeCompensationfrequency>0</EmployeeCompensationfrequency>
    <EmployeeCompensationRate>0</EmployeeCompensationRate>
    <DistrictName>Westminster</DistrictName>
    <RegionName>London</RegionName>
    <ChannelName>English Channel</ChannelName>
    <DefaultLocation>13</DefaultLocation>
  </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
EmployeeName,EmployeeUsername,Last_Name,SpecialIdentifier,IsPartTime,EmployeeID,StoreName,StoreID,ManagerApproved,TotalClockedMinutes,OTClockedMinutes,DoubleOTClockedMinutes,TotalScheduleMinutes,PartTimeVacationEarned,VacationUsedHours,SickUsedHours,PersonalUsedHours,ThresholdConflict,SupervisorName,EmployeeGroup,EmployeeCompensationType,EmployeeCompensationfrequency,EmployeeCompensationRate,DistrictName,RegionName,ChannelName,DefaultLocation
iQmetrix Employee,iQmetrix.Employee,Employee,912345987654321,0,249,100: My Network LLC - Anchorage,6679,0,0,0,0,240,0,0,0,0,-1 0 0 0 0 0 0 0 0,,Group,5,0,0,Westminster,London,English Channel,13

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 Manager Override Report

For more information, see Manager Override Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/ManagerOverrideReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheManagerOverrideReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/ManagerOverrideReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1");
    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 GettingTheManagerOverrideReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/ManagerOverrideReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1");
     
    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/ManagerOverrideReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ManagerOverrideReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SecurityCode": "DISCOUNT",
        "SecurityOverrideTypeID": 11,
        "LocationID": 21,
        "StoreName": "84 West",
        "RequestedBy": "iQmetrix Employee",
        "RequestedByID": 221,
        "GeneratedBy": "iQmetrix Employee",
        "GeneratedByID": 221,
        "UsedBy": "iQmetrix Employee",
        "UsedByID": 221,
        "CreatedDate": "2015-01-07T14:46:08.87",
        "ExpiryDate": "2015-01-30T14:46:08.87",
        "AppliedDate": "2015-01-07T14:46:08.87",
        "InvoiceID": 122081,
        "Invoice": "REDSTIN401",
        "CustomerID": -1,
        "Customer": "No Customer",
        "Comments": "Vacation",
        "RecordType": 2,
        "AuthType": 2
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SecurityCode": "DISCOUNT",
            "SecurityOverrideTypeID": 11,
            "LocationID": 21,
            "StoreName": "84 West",
            "RequestedBy": "iQmetrix Employee",
            "RequestedByID": 221,
            "GeneratedBy": "iQmetrix Employee",
            "GeneratedByID": 221,
            "UsedBy": "iQmetrix Employee",
            "UsedByID": 221,
            "CreatedDate": "2015-01-07T14:46:08.87",
            "ExpiryDate": "2015-01-30T14:46:08.87",
            "AppliedDate": "2015-01-07T14:46:08.87",
            "InvoiceID": 122081,
            "Invoice": "REDSTIN401",
            "CustomerID": -1,
            "Customer": "No Customer",
            "Comments": "Vacation",
            "RecordType": 2,
            "AuthType": 2
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SecurityCode>DISCOUNT</SecurityCode>
    <SecurityOverrideTypeID>11</SecurityOverrideTypeID>
    <LocationID>21</LocationID>
    <StoreName>84 West</StoreName>
    <RequestedBy>iQmetrix Employee</RequestedBy>
    <RequestedByID>221</RequestedByID>
    <GeneratedBy>iQmetrix Employee</GeneratedBy>
    <GeneratedByID>221</GeneratedByID>
    <UsedBy>iQmetrix Employee</UsedBy>
    <UsedByID>221</UsedByID>
    <CreatedDate>2015-01-07T14:46:08.87</CreatedDate>
    <ExpiryDate>2015-01-30T14:46:08.87</ExpiryDate>
    <AppliedDate>2015-01-07T14:46:08.87</AppliedDate>
    <InvoiceID>122081</InvoiceID>
    <Invoice>REDSTIN401</Invoice>
    <CustomerID>-1</CustomerID>
    <Customer>No Customer</Customer>
    <Comments>Vacation</Comments>
    <RecordType>2</RecordType>
    <AuthType>2</AuthType>
  </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
SecurityCode,SecurityOverrideTypeID,LocationID,StoreName,RequestedBy,RequestedByID,GeneratedBy,GeneratedByID,UsedBy,UsedByID,CreatedDate,ExpiryDate,AppliedDate,InvoiceID,Invoice,CustomerID,Customer,Comments,RecordType,AuthType
DISCOUNT,11,21,84 West,iQmetrix Employee,221,iQmetrix Employee,221,iQmetrix Employee,221,2015-01-07T14:46:08.87,2015-01-30T14:46:08.87,2015-01-07T14:46:08.87,122081,REDSTIN401,-1,No Customer,Vacation,2,2

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 Manager Time Sheet Approval Report

For more information, see Manager Time Sheet Approval Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/ManagerTimeSheetApprovalReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheManagerTimeSheetApprovalReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/ManagerTimeSheetApprovalReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&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 GettingTheManagerTimeSheetApprovalReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/ManagerTimeSheetApprovalReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&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/ManagerTimeSheetApprovalReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ManagerTimeSheetApprovalReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "HRDate": "2015-03-30T00:00:00",
        "TotalClockedHours": 1,
        "EmployeeID": 2319,
        "EmployeeName": "James Smith",
        "EmployeeUsername": "james.smith",
        "SpecialIdentifier": "912345987654321",
        "MaxLastName": "Smith",
        "StoreID": 13,
        "StoreName": "Corporate Office",
        "DistrictName": "I-10 Area",
        "RegionName": "Florida",
        "ChannelName": "First Channel",
        "SupervisorName": "Adam West",
        "SupervisorUsername": "Adam.West",
        "EmployeeGroup": "100% (35% GP)",
        "DistrictID": 2,
        "RegionID": 2,
        "EmployeeVerified": 0,
        "ManagerVerified": 0,
        "OTClockedHours": 0,
        "DoubleOTClockedHours": 0,
        "ScheduledHours": 0,
        "Revised": 1,
        "ThresholdConflict": "29 -1 2400 -1 -1 -1 -1 -1 -1",
        "EmployeeCompensationType": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "HRDate": "2015-03-30T00:00:00",
            "TotalClockedHours": 1,
            "EmployeeID": 2319,
            "EmployeeName": "James Smith",
            "EmployeeUsername": "james.smith",
            "SpecialIdentifier": "912345987654321",
            "MaxLastName": "Smith",
            "StoreID": 13,
            "StoreName": "Corporate Office",
            "DistrictName": "I-10 Area",
            "RegionName": "Florida",
            "ChannelName": "First Channel",
            "SupervisorName": "Adam West",
            "SupervisorUsername": "Adam.West",
            "EmployeeGroup": "100% (35% GP)",
            "DistrictID": 2,
            "RegionID": 2,
            "EmployeeVerified": 0,
            "ManagerVerified": 0,
            "OTClockedHours": 0,
            "DoubleOTClockedHours": 0,
            "ScheduledHours": 0,
            "Revised": 1,
            "ThresholdConflict": "29 -1 2400 -1 -1 -1 -1 -1 -1",
            "EmployeeCompensationType": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <HRDate>2015-03-30T00:00:00</HRDate>
    <TotalClockedHours>1</TotalClockedHours>
    <EmployeeID>2319</EmployeeID>
    <EmployeeName>James Smith</EmployeeName>
    <EmployeeUsername>james.smith</EmployeeUsername>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <MaxLastName>Smith</MaxLastName>
    <StoreID>13</StoreID>
    <StoreName>Corporate Office</StoreName>
    <DistrictName>I-10 Area</DistrictName>
    <RegionName>Florida</RegionName>
    <ChannelName>First Channel</ChannelName>
    <SupervisorName>Adam West</SupervisorName>
    <SupervisorUsername>Adam.West</SupervisorUsername>
    <EmployeeGroup>100% (35% GP)</EmployeeGroup>
    <DistrictID>2</DistrictID>
    <RegionID>2</RegionID>
    <EmployeeVerified>0</EmployeeVerified>
    <ManagerVerified>0</ManagerVerified>
    <OTClockedHours>0</OTClockedHours>
    <DoubleOTClockedHours>0</DoubleOTClockedHours>
    <ScheduledHours>0</ScheduledHours>
    <Revised>1</Revised>
    <ThresholdConflict>29 -1 2400 -1 -1 -1 -1 -1 -1</ThresholdConflict>
    <EmployeeCompensationType>0</EmployeeCompensationType>
  </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
HRDate,TotalClockedHours,EmployeeID,EmployeeName,EmployeeUsername,SpecialIdentifier,MaxLastName,StoreID,StoreName,DistrictName,RegionName,ChannelName,SupervisorName,SupervisorUsername,EmployeeGroup,DistrictID,RegionID,EmployeeVerified,ManagerVerified,OTClockedHours,DoubleOTClockedHours,ScheduledHours,Revised,ThresholdConflict,EmployeeCompensationType
2015-03-30T00:00:00,1,2319,James Smith,james.smith,912345987654321,Smith,13,Corporate Office,I-10 Area,Florida,First Channel,Adam West,Adam.West,100% (35% GP),2,2,0,0,0,0,0,1,29 -1 2400 -1 -1 -1 -1 -1 -1,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

GET the Requested Time Off Report

For more information, see Requested Time Off Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/RequestedTimeOffReport?Type=4&Status=5&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheRequestedTimeOffReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/RequestedTimeOffReport?Type=4&Status=5&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1");
    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 GettingTheRequestedTimeOffReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/RequestedTimeOffReport?Type=4&Status=5&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1");
     
    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/RequestedTimeOffReport?Type=4&Status=5&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[RequestedTimeOffReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "RequestID": 5,
        "EmployeeID": 19,
        "EmployeeName": "iQmetrix Employee",
        "Username": "iQmetrix.Employee",
        "EmployeeLastName": "Armstrong",
        "SpecialIdentifier": "912345987654321",
        "Role": "Sales Representative",
        "Title": "ZHello Title!",
        "ManagerName": "Trey Fowler",
        "Type": 1,
        "Status": 2,
        "DateFrom": "2011-03-25T09:00:00",
        "DateTo": "2011-03-25T19:00:00",
        "DaysRequested": 1,
        "Notes": "taking off for wedding",
        "ManagerNotes": "",
        "Paid": false,
        "PaidNotes": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "RequestID": 5,
            "EmployeeID": 19,
            "EmployeeName": "iQmetrix Employee",
            "Username": "iQmetrix.Employee",
            "EmployeeLastName": "Armstrong",
            "SpecialIdentifier": "912345987654321",
            "Role": "Sales Representative",
            "Title": "ZHello Title!",
            "ManagerName": "Trey Fowler",
            "Type": 1,
            "Status": 2,
            "DateFrom": "2011-03-25T09:00:00",
            "DateTo": "2011-03-25T19:00:00",
            "DaysRequested": 1,
            "Notes": "taking off for wedding",
            "ManagerNotes": "",
            "Paid": false,
            "PaidNotes": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <RequestID>5</RequestID>
    <EmployeeID>19</EmployeeID>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <Username>iQmetrix.Employee</Username>
    <EmployeeLastName>Armstrong</EmployeeLastName>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <Role>Sales Representative</Role>
    <Title>ZHello Title!</Title>
    <ManagerName>Trey Fowler</ManagerName>
    <Type>1</Type>
    <Status>2</Status>
    <DateFrom>2011-03-25T09:00:00</DateFrom>
    <DateTo>2011-03-25T19:00:00</DateTo>
    <DaysRequested>1</DaysRequested>
    <Notes>taking off for wedding</Notes>
    <ManagerNotes></ManagerNotes>
    <Paid>false</Paid>
    <PaidNotes></PaidNotes>
  </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
RequestID,EmployeeID,EmployeeName,Username,EmployeeLastName,SpecialIdentifier,Role,Title,ManagerName,Type,Status,DateFrom,DateTo,DaysRequested,Notes,ManagerNotes,Paid,PaidNotes
5,19,iQmetrix Employee,iQmetrix.Employee,Armstrong,912345987654321,Sales Representative,ZHello Title!,Trey Fowler,1,2,2011-03-25T09:00:00,2011-03-25T19:00:00,1,taking off for wedding,,false,

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 Token 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
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?