Web Service Interface for TimeWorks. Please also see our newer API at /pg/api12.asmx.

• Using this API requires that you create an AuthHeader object to pass credentials to the system. (Our newer APIs don't require this)
• Errors in most cases are returned in the form of SOAP Exceptions.

The following operations are supported. For a formal definition, please review the Service Description.

• AddEmployee
  This is deprecated and is not the best way to add an employee. Instead, use our EEIDSubmit call found in our most recent API. Nevertheless, it currently still works with both TimeWorks and TimeWorksPlus.
• AddEmployeeRequired
  This is deprecated and is not the best way to add an employee. Instead, use our EEIDSubmit call found in our most recent API.
• DeleteEmployeePunch
  Delete punch record from SwipeClock TimeWorks.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible, has no effect on records in TimeWorksPlus.
• GetActiveEmployeeCount
  Get a billing count of active employees for previous months. This count is derived from the data we generate and use for billing within the first few days of each month, and in most cases, doesn't change once we've calculated it for a month that just ended.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with Glue: Fully compatible
• GetActivityFile
  Returns Download activity file without filters, or sorts, or labor mapping
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible - use GetFinalizedPayroll in our latest API instead.
• GetActivityFileLaborMapped
  Returns Download activity file without filters, or sorts. Labor Mapping is a comma seperated list, available options are (X,Y,Z,D,L,S)
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible - use GetFinalizedPayroll in our latest API instead.
• GetAllSiteCardsFiltered
  Will return an XML string that contains all time card information after scripts. Start and End date should be in YYYY-mm-DD format
• GetEmployee
  Based on the site given in the SOAP header, a list of all employees will be returned in an XML string that can be parsed and read in any way needed for your payroll software. Returns a single employee based on the SwipeClock-assigned unique ID (which you can get by making calls to other WebMethods such as GetEmployees that return the entire employee roster).
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Compatible, but only returns data in fields that are built-in and common to TimeWorksPlus and TimeWorks, and does not provide dated revisions of date-versioned fields. Keep in mind that TimeWorksPlus and TimeWorks share the same employee database. This WebMethod implementation lacks awareness of TimeWorksPlus's ability to add custom fields in employee setup, as well as date-versioned fields.
  • Future plans for this WebMethod: We recommend that employee identity information be pushed to SwipeClock rather than pulled, so that most or all changes to employee data is done in a central place (ideally the service bureau software). For example, a good arrangement is to have SwipeClock responsible for setting card numbers, but having everything else (like name, department, payrate) configured from the payroll software, and changes pushed using the EEIDSubmit call found in our latest API. This methodology typically negates the need to pull employee roster data from SwipeClock.
• GetEmployeeBySwipeclockUniqueID
  Same as GetEmployee, returns data for the employee identified by the Swipeclock-unique (integer) passed to the method.
• GetEmployeeCard
  Return a temporary URL to view the employee's time card, which doesn't require or contain any authentication information, and which is valid for twenty minutes.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible. This call strictly shows information from the TimeWorks system.
  • Future plans for this WebMethod: To offer a new method that displays the time card from either system, automatically determining which system to access.
• GetEmployees
  Same as GetEmployee, but gets all employees (including inactive ones).
• GetEmployees2
  Same as GetEmployees, but adds a boolean option that allows exclusion of inactive/terminated employees.
• GetEmployeesByFilter
  Same as GetEmployees, but adds a filter option that allows narrowing of the selection. All employees, including inactive ones, are returned.
• GetEmployeesByFilter2
  Same as GetEmployeesByFilter, but also adds an option to include or exclude inactive/terminated employees.
• GetEmployeesOverload
  Same as GetEmployees, but return value is an XML string. This was added for a one-off purpose and should be considered deprecated.
• GetOneTimeCredential
  Returns a temporary one-time password to log the user of your choice into the web site.
  • Compatibility with TimeWorks: Superseded by GetOneTimeCredential in our newer API. Use it instead of this.
  • Compatibility with TimeWorksPlus: Superseded by GetOneTimeCredential in our newer API. Use it instead of this.
• GetPayPeriod
  Returns the pay period containing theDate, as well as the one before.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Compatible with limitations. This will only recognize and return the pay periods that were configured when the account was set up. If the client has used TimeWorksPlus's feature that allows changing the pay period schedule, that change will not be reflected here.
• GetPunchInfo
  Get raw data row regarding an employee punch from the database.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible
• GetSiteCards
  Will return an XML string that contains all time card information after scripts. Start and End date should be in YYYY-mm-DD format
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible.
• GetSiteCardsDownloadFiltered
  Works the same as GetSiteCardsFiltered but access downloading statements in scripts (e.g. if(downloading = true)).Start and End date should be in YYYY-mm-DD format.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible.
• GetSiteCardsFiltered
  Will return an XML string that contains all time card information after scripts. Start and End date should be in YYYY-mm-DD format
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible.
• GetSiteInfo
  Returns information about a client account
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Compatible with limitations. SwipeClock TimeWorks and TimeWorksPlus share a common client database, but many options available in TimeWorksPlus are not represented in this WebMethod's return value.
• GetSites
  Get a list of site numbers and names based on login id
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Fully compatible, except that logins that have access to other clients via TimeWorksPlus's multi-client login feature will only show the home client and not the full list of accessible accounts.
  Please note the login parameter is deprecated and ignored - actual login is taken from the auth header.
• GetSitesByMasterReseller
  Get a list of site numbers and names that are available to a master reseller
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with Glue: Fully compatible
• GetTerminalBatches
  Get details on recent TimeClock/FlexClock transmissions. IgnoreThru can be 0 to get twenty most recent transmissions, or a previously retrieved RecordNumber to get up to 20 batches newer than that. Please note that the schema for the return value is subject to change without notice.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Fully compatible
  • Applies to: TimeClock, FlexClock (including Z Series, Vx Series, L1/LA2000, and HandPunch)
  • Does not apply to: WebClock, VoiceClock, Punch submission WebMethods
• RemoveEmployee
  Destructively removes an employee from the SwipeClock system. Date information should be in YYYY-mm-DD format
  • Compatibility with TimeWorks: Fully compatible. Associated time data is permanently lost.
  • Compatibility with TimeWorksPlus: Fully compatible.
    • Causes side effects if you delete an employee that has finalized records - mainly, the finalized records will disappear from the user interface and become inaccessible, despite the records remaining available through the GetFinalizedPayroll API.
    • Never use this for deleting employees simply because they are separated or terminated - only use this for deleting employees that were recently added in error.
    • In TimeWorksPlus, if you delete an employee that has recent unfinalized punch activity from clocks, that activity returns to the Unmatched Punches screen and can be added to a new employee.
• UpdateEmployee
  Update employee information, each field is required and will overwrite the employee record based on the information that is sent to the method. This is deprecated and is not the best way to update an employee. Instead, use our EEIDSubmit call found in our most recent API. Nevertheless, it currently still works with both TimeWorks and TimeWorksPlus. Currently, TimeWorksPlus users may see a delay in seeing updates made through this WebMethod due to TimeWorksPlus's caching system. If you use EEIDSubmit instead, there is no delay.
• UpdateEmployeeFields
  Updates fields in an employee record, optionally adding a new employee if they don't already exist.This is deprecated and is not the best way to update an employee. Instead, use our EEIDSubmit call found in our most recent API. Nevertheless, it currently still works with both TimeWorks and TimeWorksPlus. Currently, TimeWorksPlus users may see a delay in seeing updates made to existing employees through this WebMethod due to TimeWorksPlus's caching system. If you use EEIDSubmit instead, there is no delay.
• UpdateEmployeeFieldsGlue
  Updates fields in an employee record, optionally adding a new employee if they don't already exist.This method is compatible with TimeWorksPlus, but there is better version in the TimeWorksPlus API. To update a field with an "Effective Date", use a "/" (forwardslash) followed by a date after the field name. (Example: 'Location/02/01/2013=Office'.)
• UpdateEmployeeTime
  Update an employees time record and will update based on information passed. Any null or blank value is what will be written to the time card.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible.
• UpdateEmployeeTimeUTC
  Update an employee's time record and will update based on information passed. Any null or blank value is what will be written to the time card.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Not compatible
• UpdateSiteSetting
  Updates configuration fields for a client account.
  • The only implemented allowable FieldToUpdate is WebClockIPFilter, and its value is a comma-separated list that has a maximum length of 200 characters.
  • Compatibility with TimeWorks: Fully compatible
  • Compatibility with TimeWorksPlus: Fully compatible. Reminder, only the newest WebClock (located at /webclock) and the WebClock within TimeWorksPlus's Employee Self Service (ESS) are compatible with TimeWorksPlus.