http://econz.org/api.php?action=feedcontributions&user=Philipc&feedformat=atom - User contributions [en]2024-03-29T06:30:20ZUser contributionsMediaWiki 1.19.20+dfsg-2.3http://econz.org/index.php/TimecardTimecard2021-12-08T21:59:26Z<p>Philipc: /* Welcome to the Econz Wireless Timecard Developer page */</p>
<hr />
<div>{{MainSectionLinks}}<br />
==Welcome to the [http://www.econz.com Econz Wireless] Timecard Developer page==<br />
Timecard is the Mobile Timesheet Software solution developed by Econz Wireless. <br />
<br />
It is provided to customers as a subscriber based service.<br />
<br />
Employers can create tasks using a Web Based interface, while the employees will be able to select and track their time against each task through a variety of compatible field devices, including Tablets and a range of cell phones (e.g. Blackberry, Nokia, Android and iPhone). Up to the minute reports of the time spent on various tasks/jobs can be generated for individual employees, teams, and for the organization as a whole.<br />
<br />
For companies which already have an time tracking system, but which lacks the mobile time and task management capabilities of Timecard, we have created a set of SOAP Web Services (http://www.w3.org/2002/ws/). These services allow any external system to connect directly to Timecard, adding this highly effective management tool directly into the company work flow for minimal cost and effort.<br />
<br />
To assist with the integration of Timecard and other management systems, we have created a number of DotNet [[Client Software]] examples which utilize Web Services to retrieve and manage time and task data in Timecard. A Simple Java example to connect is [[Java TimeCard Example | here]].<br />
<br />
For more information please see http://www.econz.com<br />
<br />
The [[timecard Soap API | Timecard SOAP API]] is documented [[timecard Soap API | here]]. The raw timecard WSDL is available [https://timecardweb.econz.com/axis/services/timecard1Soap?wsdl here]. Human readable documentation generated from the latest WSDL is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] (this is the best link to use if you know what you are doing!).<br />
<br />
To test your SOAP client, Econz provides the Sandpit system. Notes for using the Sandpit system are documented [[Notes for using Sandpit system |here]].</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2020-08-20T08:54:26Z<p>Philipc: Fix links</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardweb.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|GetLastUserEventsResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69853 getLastUserEvents]<br />
|[[UserIDBean]]<br />
|Retrieves last user events (including GPS location info if available).<br />
|---- bgcolor=#EDEDFF<br />
|GetUserGPSResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69223 getUserGPS]<br />
|[[UserIDBean]], userPK, start date, end date<br />
|Retrieves user GPS locations for the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|GetGpsEventsResult<br />
|getGPSEvents<br />
|[[UserIDBean]], userPK, teamPK, startDate, endDate<br />
|Retrieves user event info with timezone of the event as recorded by the phone.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1519 sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1522 wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1525 createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1528 deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1531 addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1534 removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1537 sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1540 wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1543 getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1547 addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69826 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1550 removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1618 addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1624 addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1621 deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[https://services.w3.org/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-viewer.xsl&amp;xmlfile=https://eserviceweb.econz.com/axis/services/timecard1Soap?wsdl&amp;transform=Submit#op.d1e1627 getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/UserBeanUserBean2020-05-08T23:16:32Z<p>Philipc: Fix size of mobileNumber field</p>
<hr />
<div>== Description ==<br />
This class represents all the details related to users of the EService system.<br />
<br />
== Fields ==<br />
<br />
The data fields of this object.<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|deleted<br />
|boolean<br />
|1<br />
|No<br />
|An indication of the deleted state of the record. True indicates the user has been deleted and can no longer be used to logon or work on EService/Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String <br />
|50<br />
|No<br />
|A short description of the user.<br />
|---- bgcolor=#EDEDFF<br />
|emailAddress<br />
|String <br />
|64<br />
|No<br />
|The email address of the user.<br />
|---- bgcolor=#EDEDFF<br />
|faxNumber<br />
|String<br />
|30<br />
|No<br />
|The user's fax number.<br />
|---- bgcolor=#EDEDFF<br />
|loginID<br />
|String<br />
|30<br />
|Yes<br />
|The logon id (logon name) used to log onto the EService/Timecard system.<br />
|---- bgcolor=#EDEDFF<br />
|mobileNumber<br />
|String <br />
|50<br />
|No<br />
|The mobile phone number of the user.<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|50<br />
|Yes<br />
|The name of the user.<br />
|---- bgcolor=#EDEDFF<br />
|pagerNumber<br />
|String<br />
|30<br />
|No<br />
|The pager number of the user.<br />
|---- bgcolor=#EDEDFF<br />
|phoneNumber<br />
|String<br />
|30<br />
|No<br />
|The standard phone number for the user.<br />
|---- bgcolor=#EDEDFF<br />
|primaryKey<br />
|String <br />
|9<br />
|Yes<br />
|The EService/Timecard assigned primary key for the user.<br />
|---- bgcolor=#EDEDFF<br />
|securityAnswer<br />
|String<br />
|32<br />
|No<br />
|The user's answer to their special security verification question.<br />
|---- bgcolor=#EDEDFF<br />
|securityQuestion<br />
|String<br />
|128<br />
|No<br />
|The user's special security verification question.<br />
|---- bgcolor=#EDEDFF<br />
|synchronisation<br />
|[[SynchronisationBean]] array<br />
|N/A<br />
|No<br />
|An array of [[SynchronisationBean]] objects, showing all current sync flags and custom data associated with the user record.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String <br />
|50<br />
|No<br />
|The local timezone of the user.<br />
|---- bgcolor=#EDEDFF<br />
|updateIndex<br />
|int <br />
|10<br />
|Yes<br />
|The time derived int value of the user record, used for concurrency checks.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String <br />
|9<br />
|Yes<br />
|One of the user types specified for this organisation during initial setup.<br />
|}</div>Philipchttp://econz.org/index.php/UserBeanUserBean2020-05-08T23:15:48Z<p>Philipc: Fix size of name field</p>
<hr />
<div>== Description ==<br />
This class represents all the details related to users of the EService system.<br />
<br />
== Fields ==<br />
<br />
The data fields of this object.<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|deleted<br />
|boolean<br />
|1<br />
|No<br />
|An indication of the deleted state of the record. True indicates the user has been deleted and can no longer be used to logon or work on EService/Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String <br />
|50<br />
|No<br />
|A short description of the user.<br />
|---- bgcolor=#EDEDFF<br />
|emailAddress<br />
|String <br />
|64<br />
|No<br />
|The email address of the user.<br />
|---- bgcolor=#EDEDFF<br />
|faxNumber<br />
|String<br />
|30<br />
|No<br />
|The user's fax number.<br />
|---- bgcolor=#EDEDFF<br />
|loginID<br />
|String<br />
|30<br />
|Yes<br />
|The logon id (logon name) used to log onto the EService/Timecard system.<br />
|---- bgcolor=#EDEDFF<br />
|mobileNumber<br />
|String <br />
|30<br />
|No<br />
|The mobile phone number of the user.<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|50<br />
|Yes<br />
|The name of the user.<br />
|---- bgcolor=#EDEDFF<br />
|pagerNumber<br />
|String<br />
|30<br />
|No<br />
|The pager number of the user.<br />
|---- bgcolor=#EDEDFF<br />
|phoneNumber<br />
|String<br />
|30<br />
|No<br />
|The standard phone number for the user.<br />
|---- bgcolor=#EDEDFF<br />
|primaryKey<br />
|String <br />
|9<br />
|Yes<br />
|The EService/Timecard assigned primary key for the user.<br />
|---- bgcolor=#EDEDFF<br />
|securityAnswer<br />
|String<br />
|32<br />
|No<br />
|The user's answer to their special security verification question.<br />
|---- bgcolor=#EDEDFF<br />
|securityQuestion<br />
|String<br />
|128<br />
|No<br />
|The user's special security verification question.<br />
|---- bgcolor=#EDEDFF<br />
|synchronisation<br />
|[[SynchronisationBean]] array<br />
|N/A<br />
|No<br />
|An array of [[SynchronisationBean]] objects, showing all current sync flags and custom data associated with the user record.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String <br />
|50<br />
|No<br />
|The local timezone of the user.<br />
|---- bgcolor=#EDEDFF<br />
|updateIndex<br />
|int <br />
|10<br />
|Yes<br />
|The time derived int value of the user record, used for concurrency checks.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String <br />
|9<br />
|Yes<br />
|One of the user types specified for this organisation during initial setup.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2020-02-24T08:09:12Z<p>Philipc: /* The Interface Definition */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardweb.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|GetLastUserEventsResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69853 getLastUserEvents]<br />
|[[UserIDBean]]<br />
|Retrieves last user events (including GPS location info if available).<br />
|---- bgcolor=#EDEDFF<br />
|GetUserGPSResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69223 getUserGPS]<br />
|[[UserIDBean]], userPK, start date, end date<br />
|Retrieves user GPS locations for the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|GetGpsEventsResult<br />
|getGPSEvents<br />
|[[UserIDBean]], userPK, teamPK, startDate, endDate<br />
|Retrieves user event info with timezone of the event as recorded by the phone.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69826 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2020-02-24T08:07:22Z<p>Philipc: Added getGPSEvents</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|GetLastUserEventsResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69853 getLastUserEvents]<br />
|[[UserIDBean]]<br />
|Retrieves last user events (including GPS location info if available).<br />
|---- bgcolor=#EDEDFF<br />
|GetUserGPSResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69223 getUserGPS]<br />
|[[UserIDBean]], userPK, start date, end date<br />
|Retrieves user GPS locations for the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|GetGpsEventsResult<br />
|getGPSEvents<br />
|[[UserIDBean]], userPK, teamPK, startDate, endDate<br />
|Retrieves user event info with timezone of the event as recorded by the phone.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69826 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/User:RuskindUser:Ruskind2019-06-06T01:49:05Z<p>Philipc: </p>
<hr />
<div>Ruskin Dantra<br><br />
Software Engineer<br> <br />
<br />
ECONZ Wireless. Visit our web site http://www.econz.com<br></div>Philipchttp://econz.org/index.php/Latest_NewsLatest News2019-06-06T01:47:54Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
<br />
==== 07 March 2019 -- [[User:Philipc|Philipc]] ====<br />
Updated Timecard SOAP documentation to include info on retrieving mobile device GPS data.<br />
<br />
==== 20 September 2016 (NZST) -- [[User:Philipc|Philipc]] ====<br />
Regular and observant visitors may have noticed that our econz.org hosting has been changed. Although, other than the fact that our visitor count has been reset (check out previous count [http://web.archive.org/web/20160518054736/http://www.econz.org/wiki/index.php/Main_Page here] - thanks to the wayback machine!) everything else is the same as before.<br />
<br />
==== 10 September 2015 (NZST) -- [[User:Luish|Luish]] ====<br />
Timecard CS Client: Updated compatibility with newer vesions of Visual Studio for C# version. The application is now pointing to the American Pre-Production wsdl.<br />
<br />
==== 07 September 2015 (NZST) -- [[User:Luish|Luish]] ====<br />
EService CS Client: Updated compatibility with newer vesions of Visual Studio for C# version. The application is now pointing to the most recent NADS5 wsdl. Updated with a setting used to prevent errors when user is working behind a proxy that doesn’t support Expect100Continue.<br />
<br />
==== 23 December 2009 (NZST) -- [[User:Ruskind|Ruskind]] ====<br />
Added explicit documentation for callback interface and retested EService callback service with both [http://msdn.microsoft.com/en-us/library/bb332338.aspx WCF] and [http://msdn.microsoft.com/en-us/library/yzbxwf53(VS.71).aspx ASMX] callback interfaces using VS2008 and VS2003. Refer to [[EService Soap API]] for more information.<br />
<br />
==== 30 July 2009 (NZST) -- [[User:Philipc|Philipc]] ====<br />
The Sandpit system is not currently available, please contact [http://econz.com/contact.html ECONZ] if you wish to do integration testing. <br />
<br />
==== 12 October 2007 (NZST) -- [[User:Tristan|Tristan]] ====<br />
Added note on the Integrator to the [[Client Software|Client_Software]] page.<br />
<br />
==== 28 March 2006 (NZST) -- [[User:Philipc|Philipc]] ====<br />
Source code (and pre-built binaries) of example client applications our now available to [[Downloads | download]] for the EService SOAP interface (previously only Timecard examples were available for download). Examples of both EService and Timecard SOAP clients are available and these examples are written in either C# or VB .NET.<br />
<br />
==== 14 February 2006 (NZST) -- [[User:Tristan|Tristan]] ====<br />
The "Sandpit" system has been released and is available for developers to use as a test bed. The URL for EService is http://nadssandpit.econz.com, and for Timecard the URL is http://nadssandpit.econz.com/timecard. Please contact an [[ECONZ Integration Consultant]] to set up a test organization for use in your testing. Alternatively you might like to use our global [[sandpit demo login|demo login]] or have a go at [[sandpit org wizard|creating your own demo organization]] on the sandpit system.<br />
<br />
==== 26 January 2006 (NZST) -- [[User:Tristan|Tristan]] ====<br />
Major revamp of the Wiki in relation to the open sourcing of the test clients. We are also setting up a new "sandpit" server, to allow users and developers to run and test the SOAP Test Clients, '''Time'''card and EService servers, which should be available early February. Release of the Test Clients is therefore being delayed until the server is deployed.<br />
<br />
==== 12 January 2006 (NZST) -- [[User:Tristan|Tristan]] ====<br />
ECONZ has now created an open source project on [http://sourceforge.net SourceForge] for hosting various Web Services Demo clients. Both source code and binary releases of the Timecard Test Clients can be found in the [http://sourceforge.net/projects/econz-timecard/ ECONZ Timecard] project.<br />
<br />
==== 09 November 2005 (NZST) -- [[User:Philipc|Philipc]] ====<br />
Significant tidy up of the Timecard SOAP documentation including links to the java doc style auto generated documentation.<br />
<br />
==== 06 September 2005 (NZST) -- [[User:Tristan|Tristan]] ====<br />
<br />
Final additions to the EService SOAP 3 API have been made, adding field sizes and requirements to all the basic data types to be used when calling the API.<br />
<br />
==== 3 August 2005 (NZST) -- [[User:Tristan|Tristan]] ====<br />
<br />
Added the first cut of the documentation for the Timecard SOAP API. The API documentation will continue to be revised and enhanced over the coming months.<br />
<br />
==== 16 June 2005 (NZST) -- [[User:Tristan|Tristan]] ====<br />
<br />
The [[Frequently Asked Questions]] page has been updated with a new look, and several more questions have been added.</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2019-03-07T23:06:28Z<p>Philipc: Added some GPS method doc</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|GetLastUserEventsResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69853 getLastUserEvents]<br />
|[[UserIDBean]]<br />
|Retrieves last user events (including GPS location info if available).<br />
|---- bgcolor=#EDEDFF<br />
|GetUserGPSResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69223 getUserGPS]<br />
|[[UserIDBean]], userPK, start date, end date<br />
|Retrieves user GPS locations for the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69826 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Developer_ZoneDeveloper Zone2019-02-15T08:01:48Z<p>Philipc: Undo revision 2208 by Philipc (talk)</p>
<hr />
<div>{{MainSectionLinks}}<br />
==Welcome to the [http://www.econz.com Econz Wireless] EService and '''Time'''card Developer Zone==<br />
<br />
=== Site Purpose ===<br />
This site has been provided to assist developers in making use of various [http://www.econz.com Econz Wireless] software products. It contains examples of software used to access the SOAP APIs of [http://www.eservice.econz.com EService] and [http://www.timecard.econz.com Timecard]. Both these products are provided as a hosted service. Users of these services are not charged for the use of the websites or webservices. Monthly fees do however apply to Field Devices (generally these are smart phones) that connect to the hosted services.<br />
<br />
This site also contains documentation of the SOAP APIs, the methods available, their return values, the data structures passed in and returned, and any related notes.<br />
<br />
The complete source code for all Test Clients is available, including solutions in Visual Studio 2003, 2005, 2008 and newer in Visual Basic .NET and C# (a Java starter is also [[Java_TimeCard_Example|available]]). The Test Client source can be [[Downloads|downloaded]] and examined for inclusion in other projects, or used as reference material for the development of your companies custom applications.<br />
<br />
=== Site Sections ===<br />
<br />
* [[Latest News]] : Updated regularly with important news and information about fixes, source code changes, and new releases.<br />
* [[Frequently Asked Questions | F.A.Q.]] : A list of often-asked questions about EService and Timecard.<br />
* [[EService]] : Information about the [http://www.econz.com ECONZ] Job Management and Wireless Dispatch system.<br />
* [[Timecard]] : Information about the [http://www.econz.com ECONZ] Mobile Timesheet Software solution.<br />
* [[ECONZ Web Services | Web Services]] : A description of the Web Service developed for [[EService]] and [[Timecard]].<br />
* [[Client Software]] : A list of the Test Clients built and available for examination and testing.<br />
* [[Downloads]] : Links to [[Client Software]] source code and executable downloads.<br />
* [[Notes for using Sandpit system]] will show you how to use the ECONZ Sandpit server, i.e. the server running EService and Timecard which you can test you SOAP clients against.</div>Philipchttp://econz.org/index.php/Developer_ZoneDeveloper Zone2019-02-15T08:01:25Z<p>Philipc: Undo revision 2209 by Philipc (talk)</p>
<hr />
<div>{{MainSectionLinks}}<br />
==Welcome to the TALC Developer Zone==<br />
<br />
=== Site Purpose ===<br />
This site has been provided to assist developers in making use of various [http://www.econz.com Econz Wireless] software products. It contains examples of software used to access the SOAP APIs of [http://www.eservice.econz.com EService] and [http://www.timecard.econz.com Timecard]. Both these products are provided as a hosted service. Users of these services are not charged for the use of the websites or webservices. Monthly fees do however apply to Field Devices (generally these are smart phones) that connect to the hosted services.<br />
<br />
This site also contains documentation of the SOAP APIs, the methods available, their return values, the data structures passed in and returned, and any related notes.<br />
<br />
The complete source code for all Test Clients is available, including solutions in Visual Studio 2003, 2005, 2008 and newer in Visual Basic .NET and C# (a Java starter is also [[Java_TimeCard_Example|available]]). The Test Client source can be [[Downloads|downloaded]] and examined for inclusion in other projects, or used as reference material for the development of your companies custom applications.<br />
<br />
=== Site Sections ===<br />
<br />
* [[Latest News]] : Updated regularly with important news and information about fixes, source code changes, and new releases.<br />
* [[Frequently Asked Questions | F.A.Q.]] : A list of often-asked questions about EService and Timecard.<br />
* [[EService]] : Information about the [http://www.econz.com ECONZ] Job Management and Wireless Dispatch system.<br />
* [[Timecard]] : Information about the [http://www.econz.com ECONZ] Mobile Timesheet Software solution.<br />
* [[ECONZ Web Services | Web Services]] : A description of the Web Service developed for [[EService]] and [[Timecard]].<br />
* [[Client Software]] : A list of the Test Clients built and available for examination and testing.<br />
* [[Downloads]] : Links to [[Client Software]] source code and executable downloads.<br />
* [[Notes for using Sandpit system]] will show you how to use the ECONZ Sandpit server, i.e. the server running EService and Timecard which you can test you SOAP clients against.</div>Philipchttp://econz.org/index.php/Developer_ZoneDeveloper Zone2019-02-15T07:41:13Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
==Welcome to the TALC Developer Zone==<br />
<br />
''Please edit as required '''Luis'''!''<br />
<br />
=== Site Purpose ===<br />
This site has been provided to assist developers in making use of various [http://www.econz.com Econz Wireless] software products. It contains examples of software used to access the SOAP APIs of [http://www.eservice.econz.com EService] and [http://www.timecard.econz.com Timecard]. Both these products are provided as a hosted service. Users of these services are not charged for the use of the websites or webservices. Monthly fees do however apply to Field Devices (generally these are smart phones) that connect to the hosted services.<br />
<br />
This site also contains documentation of the SOAP APIs, the methods available, their return values, the data structures passed in and returned, and any related notes.<br />
<br />
The complete source code for all Test Clients is available, including solutions in Visual Studio 2003, 2005, 2008 and newer in Visual Basic .NET and C# (a Java starter is also [[Java_TimeCard_Example|available]]). The Test Client source can be [[Downloads|downloaded]] and examined for inclusion in other projects, or used as reference material for the development of your companies custom applications.<br />
<br />
=== Site Sections ===<br />
<br />
* [[Latest News]] : Updated regularly with important news and information about fixes, source code changes, and new releases.<br />
* [[Frequently Asked Questions | F.A.Q.]] : A list of often-asked questions about EService and Timecard.<br />
* [[EService]] : Information about the [http://www.econz.com ECONZ] Job Management and Wireless Dispatch system.<br />
* [[Timecard]] : Information about the [http://www.econz.com ECONZ] Mobile Timesheet Software solution.<br />
* [[ECONZ Web Services | Web Services]] : A description of the Web Service developed for [[EService]] and [[Timecard]].<br />
* [[Client Software]] : A list of the Test Clients built and available for examination and testing.<br />
* [[Downloads]] : Links to [[Client Software]] source code and executable downloads.<br />
* [[Notes for using Sandpit system]] will show you how to use the ECONZ Sandpit server, i.e. the server running EService and Timecard which you can test you SOAP clients against.</div>Philipchttp://econz.org/index.php/Developer_ZoneDeveloper Zone2019-02-15T07:40:31Z<p>Philipc: /* Welcome to the Econz Wireless EService and Timecard Developer Zone */</p>
<hr />
<div>{{MainSectionLinks}}<br />
==Welcome to the TALC Developer Zone==<br />
<br />
=== Site Purpose ===<br />
This site has been provided to assist developers in making use of various [http://www.econz.com Econz Wireless] software products. It contains examples of software used to access the SOAP APIs of [http://www.eservice.econz.com EService] and [http://www.timecard.econz.com Timecard]. Both these products are provided as a hosted service. Users of these services are not charged for the use of the websites or webservices. Monthly fees do however apply to Field Devices (generally these are smart phones) that connect to the hosted services.<br />
<br />
This site also contains documentation of the SOAP APIs, the methods available, their return values, the data structures passed in and returned, and any related notes.<br />
<br />
The complete source code for all Test Clients is available, including solutions in Visual Studio 2003, 2005, 2008 and newer in Visual Basic .NET and C# (a Java starter is also [[Java_TimeCard_Example|available]]). The Test Client source can be [[Downloads|downloaded]] and examined for inclusion in other projects, or used as reference material for the development of your companies custom applications.<br />
<br />
=== Site Sections ===<br />
<br />
* [[Latest News]] : Updated regularly with important news and information about fixes, source code changes, and new releases.<br />
* [[Frequently Asked Questions | F.A.Q.]] : A list of often-asked questions about EService and Timecard.<br />
* [[EService]] : Information about the [http://www.econz.com ECONZ] Job Management and Wireless Dispatch system.<br />
* [[Timecard]] : Information about the [http://www.econz.com ECONZ] Mobile Timesheet Software solution.<br />
* [[ECONZ Web Services | Web Services]] : A description of the Web Service developed for [[EService]] and [[Timecard]].<br />
* [[Client Software]] : A list of the Test Clients built and available for examination and testing.<br />
* [[Downloads]] : Links to [[Client Software]] source code and executable downloads.<br />
* [[Notes for using Sandpit system]] will show you how to use the ECONZ Sandpit server, i.e. the server running EService and Timecard which you can test you SOAP clients against.</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2019-01-17T21:11:33Z<p>Philipc: Updated external WSDL link to updateTaskDetails</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.N69826 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2018-06-13T23:18:13Z<p>Philipc: /* DetailedHourBreakdownBean */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1570 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|[[DateTime]]<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/UpdateTaskStartEndUpdateTaskStartEnd2018-06-13T23:16:45Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
UpdateTaskResult updateTaskStartEnd([[UserIDBean]] userID, taskID, start, end)<br />
<br />
== Description ==<br />
Updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|taskID<br />
|The indentifier for the Task.<br />
|---- bgcolor=#EDEDFF<br />
|[[DateTime]]<br />
|start<br />
|Start date for the tasks visibility window<br />
|---- bgcolor=#EDEDFF<br />
|[[DateTime]]<br />
|end<br />
|End date for the tasks visibility window<br />
|}<br />
<br />
== Return Value ==<br />
UpdateTaskResult<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448835120 auto generated] doc.''</div>Philipchttp://econz.org/index.php/JobResourceBeanJobResourceBean2018-06-13T23:16:11Z<p>Philipc: </p>
<hr />
<div>== Description ==<br />
This bean represents a particular resource used on the job. <br />
<br />
== Fields ==<br />
<br />
The data fields of this object.<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|PrimaryKey<br />
|string<br />
|9<br />
|Yes<br />
|The EService primary key of this JobResource.<br />
|---- bgcolor=#EDEDFF<br />
|Quantity<br />
|BigDecimal<br />
|8<br />
|Yes<br />
|The number of units of this resource, used on the job.<br />
|---- bgcolor=#EDEDFF<br />
|UnitValue<br />
|BigDecimal<br />
|8<br />
|Yes<br />
|The value of each unit of this resource.<br />
|---- bgcolor=#EDEDFF<br />
|Chargable<br />
|Boolean<br />
|1<br />
|Yes<br />
|An indicator for whether the resource was marked as "Chargeable" on the field device.<br />
|---- bgcolor=#EDEDFF<br />
|ResourceName<br />
|string<br />
|20<br />
|Yes<br />
|The name (primary key) of the resource used.<br />
|---- bgcolor=#EDEDFF<br />
|WhenAttached<br />
|[[DateTime]]<br />
|N/A<br />
|Yes<br />
|The date and time the resource was attached to the job.<br />
|}</div>Philipchttp://econz.org/index.php/JobPaymentBeanJobPaymentBean2018-06-13T23:15:43Z<p>Philipc: </p>
<hr />
<div>== Description ==<br />
This bean represents a particular payment received on the job. <br />
<br />
== Fields ==<br />
<br />
The data fields of this object.<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|PrimaryKey<br />
|string<br />
|9<br />
|Yes<br />
|The EService primary key of this JobResource.<br />
|---- bgcolor=#EDEDFF<br />
|UnitValue<br />
|BigDecimal <br />
|8<br />
|No<br />
|The value of the payment.<br />
|---- bgcolor=#EDEDFF<br />
|PaymentMethod<br />
|string<br />
|20<br />
|Yes<br />
|The type of the payment received.<br />
|---- bgcolor=#EDEDFF<br />
|whenPaid<br />
|[[DateTime]]<br />
|N/A<br />
|Yes<br />
|The date and time the payment was received<br />
|}</div>Philipchttp://econz.org/index.php/DateTimeDateTime2018-06-13T20:45:17Z<p>Philipc: Created page with "All xsd:DateTime parameters are TZ aware. Hence they are interpreted based on the TZ set by the client (by default it is likely UTC)."</p>
<hr />
<div>All xsd:DateTime parameters are TZ aware. Hence they are interpreted based on the TZ set by the client (by default it is likely UTC).</div>Philipchttp://econz.org/index.php/EventBeanEventBean2018-06-13T20:39:06Z<p>Philipc: </p>
<hr />
<div>== Description ==<br />
This bean is the super class of all the various types of events that may occur to a given job. When receiving one or more EventBeans, each bean will actually be an instance of one of the following event beans:<br />
<br />
*[[JobEventBean]]<br />
*[[TextMessgeEventBean]]<br />
*[[FieldDeviceEventBean]]<br />
<br />
== Fields ==<br />
<br />
The data fields of this object.<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|WhenOccurred<br />
|[[DateTime]]<br />
|TODO<br />
|}</div>Philipchttp://econz.org/index.php/RateCodeRateCode2018-01-24T20:35:54Z<p>Philipc: Created page with "If you want RateCode info in an organisation, you will need to add this via the follow webservice method call which provides a single "rateCode" to be associated with the task..."</p>
<hr />
<div>If you want RateCode info in an organisation, you will need to add this via the follow webservice method call which provides a single "rateCode" to be associated with the taskName (Job) and the userPK (Employee):<br />
<br />
addRateCode(UserIDBean userID, String taskName, String rateCode, String userPK);<br />
<br />
Here is the WSDL documentation:<br />
http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1543<br />
<br />
<br />
RateCode info is stored in a table called USER_TASK_RATE_CODE and is extracted and shown in the following webservice methods when present:<br />
* getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
* getDetailedHourSummariesWithRateCode<br />
* getDetailedUserHourSummaryWithRateCode<br />
* getDetailedUserHourSummaryWithRateCodeAndPremiumPay<br />
<br />
These methods return rate code, it is only available via webservices...</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2018-01-24T20:35:05Z<p>Philipc: /* DetailedHourBreakdownBeanWithRateCode */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1570 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|[[rateCode]]<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:43:20Z<p>Philipc: /* Various Maintenance Functions */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1570 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1567 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:40:01Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1366 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:23:28Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:20:26Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 DetailedHourBreakdownBeanWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 getDetailedHourSummariesWithRateCodeAndPremiumPay] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:16:15Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586 getDetailedHourSummariesWithRateCodeAndPremiumPay]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-14T22:15:43Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [getDetailedHourSummariesWithRateCodeAndPremiumPay http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.d1e1586]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-03T00:48:57Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of ...<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-08-03T00:46:02Z<p>Philipc: Added getDetailedHourSummariesWithRateCodeAndPremiumPay</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCodeAndPremiumPay<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination as well as an indication as to whether Premium Pay is due. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/DownloadsDownloads2017-05-08T03:23:10Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
<br />
===Econz Wireless Open Source Downloads hosted on [http://www.sourceforge.net SourceForge]===<br />
These downloads are a collection of test clients built to demonstrate the use of [[EService]] and [[Timecard]] [[ECONZ Web Services | web services]].<br />
<br />
Currently available '''downloads''':<br />
*http://sourceforge.net/projects/econz-timecard<br />
*http://sourceforge.net/projects/econz-eservice</div>Philipchttp://econz.org/index.php/Client_SoftwareClient Software2017-05-08T03:21:44Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
<br />
__TOC__<br />
== Introduction ==<br />
<br />
This page documents the various client applications that Econz Wireless provides to it's customers for integration purposes. If you wish to bypass this and go directly to the source code examples for developing your own integrations with Econz Wireless products, please go to our [[Downloads]] page.<br />
<br />
== The EService Integrator ==<br />
<br />
Developed in house, this application is designed to simplify the process of connecting external system to EService. The Integrator is designed to read incoming XML messages from Emails, Files, or Microsoft Message Queue Messages, convert them to EService Jobs, and send them into EService. The Integrator can then monitor these jobs and send XML Emails, Files, and Messages out detailing any status changes or updates to jobs in EService, allowing external systems to receive near real time job monitoring information.<br />
<br />
The Integrator uses the SOAP interface to achieve this, but no knowledge of the SOAP interface is required to use the Integrator.<br />
<br />
== EService Test Clients ==<br />
<br />
=== Built in C Sharp (C#) ===<br />
<br />
The EService CSharp Test Client application is a complete test client in the sense that it is capable of running all of the EService SOAP methods as well as processing all of the data types returned by these SOAP methods respectively. It contains an internal data storage mechanism, i.e. Datasets to store the data in xml files within the application folder, that allows for progression and saving of job and task data and thus allowing users to effectively perform any function of the website via the application interface. It can also easily switch between different organisations. Please check back soon for instructions on how to request an organisation in our EService webserver. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService SOAP methods, i.e. those methods to interact with EService webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. It represents the coding required to link an external report or data management system with EService, and the source code is available to assist developers in creating their own linking modules to EService.<br />
For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels. <br />
<br />
The documentation for the client is here : [http://iweb.econz.co.nz/wiki/images/8/81/EService_CSharp_Full_Test_Client_Documentation_1.0.pdf C# Test Client Documentation].<br />
<br />
==== Visual Studio 2003 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Client is more limited in scope compared to its C Sharp alternative as it only focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of EService how to write Visual Basic .NET program to interact with EService webserver, i.e. how to invoke an EService SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other EService SOAP methods (as well as processing the returned values) are the same.<br />
<br />
The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2008 ====<br />
The Test clients built under Visual Studio 2008 are designed to run against the Microsoft .NET Framework 3.5 SP1. The 3.5 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
<br />
== Timecard Test Clients ==<br />
=== Built in C Sharp (C#) ===<br />
The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating user events, teams, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling Timecard SOAP methods, i.e. those methods to interact with Timecard webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of Timecards write their own modules to interact with Timecard webserver. It represents the coding required to link an external report or data management system with Timecard, and the source code is available to assist developers in creating their own linking modules to Timecard.<br />
For example, should a developer need to develop a module to manage teams in Timecard webserver, he or she could have a look at the source code for the "Team Management" panel. <br />
<br />
==== Visual Studio 2003 ====<br />
The Timecard C# Full Test Client has been built to completely exercise all the functions and features of the Timecard SOAP API. It allows you to retrieve information about users events and hours of specified time intervals, and create new users and teams. Please check the [[Downloads]] page for more information about geting the source code and a test client installer.<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Clients is more limited in scope compared to its C Sharp alternative as it focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of Timecard how to write Visual Basic .NET program to interact with Timecard webserver, i.e. how to invoke an Timecard SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other Timecard SOAP methods (as well as processing the returned values) are the same. <br />
<br />
The provided Visual Basic Timecard Test Client can only access the EService SOAP method to retrieve event details of a user, within a given time period, given the primary key of the user, the start date and the end date of the period. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/</div>Philipchttp://econz.org/index.php/Client_SoftwareClient Software2017-05-08T03:21:03Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
<br />
This page documents the various client software applications that Econz Wireless provides to it's customers for integration purposes. If you wish to bypass this and go directly to the source code examples for developing your own integrations with Econz Wireless products, please go to our [[Downloads]] page.<br />
<br />
== The EService Integrator ==<br />
<br />
Developed in house, this application is designed to simplify the process of connecting external system to EService. The Integrator is designed to read incoming XML messages from Emails, Files, or Microsoft Message Queue Messages, convert them to EService Jobs, and send them into EService. The Integrator can then monitor these jobs and send XML Emails, Files, and Messages out detailing any status changes or updates to jobs in EService, allowing external systems to receive near real time job monitoring information.<br />
<br />
The Integrator uses the SOAP interface to achieve this, but no knowledge of the SOAP interface is required to use the Integrator.<br />
<br />
== EService Test Clients ==<br />
<br />
=== Built in C Sharp (C#) ===<br />
<br />
The EService CSharp Test Client application is a complete test client in the sense that it is capable of running all of the EService SOAP methods as well as processing all of the data types returned by these SOAP methods respectively. It contains an internal data storage mechanism, i.e. Datasets to store the data in xml files within the application folder, that allows for progression and saving of job and task data and thus allowing users to effectively perform any function of the website via the application interface. It can also easily switch between different organisations. Please check back soon for instructions on how to request an organisation in our EService webserver. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService SOAP methods, i.e. those methods to interact with EService webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. It represents the coding required to link an external report or data management system with EService, and the source code is available to assist developers in creating their own linking modules to EService.<br />
For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels. <br />
<br />
The documentation for the client is here : [http://iweb.econz.co.nz/wiki/images/8/81/EService_CSharp_Full_Test_Client_Documentation_1.0.pdf C# Test Client Documentation].<br />
<br />
==== Visual Studio 2003 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Client is more limited in scope compared to its C Sharp alternative as it only focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of EService how to write Visual Basic .NET program to interact with EService webserver, i.e. how to invoke an EService SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other EService SOAP methods (as well as processing the returned values) are the same.<br />
<br />
The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2008 ====<br />
The Test clients built under Visual Studio 2008 are designed to run against the Microsoft .NET Framework 3.5 SP1. The 3.5 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
<br />
== Timecard Test Clients ==<br />
=== Built in C Sharp (C#) ===<br />
The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating user events, teams, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling Timecard SOAP methods, i.e. those methods to interact with Timecard webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of Timecards write their own modules to interact with Timecard webserver. It represents the coding required to link an external report or data management system with Timecard, and the source code is available to assist developers in creating their own linking modules to Timecard.<br />
For example, should a developer need to develop a module to manage teams in Timecard webserver, he or she could have a look at the source code for the "Team Management" panel. <br />
<br />
==== Visual Studio 2003 ====<br />
The Timecard C# Full Test Client has been built to completely exercise all the functions and features of the Timecard SOAP API. It allows you to retrieve information about users events and hours of specified time intervals, and create new users and teams. Please check the [[Downloads]] page for more information about geting the source code and a test client installer.<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Clients is more limited in scope compared to its C Sharp alternative as it focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of Timecard how to write Visual Basic .NET program to interact with Timecard webserver, i.e. how to invoke an Timecard SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other Timecard SOAP methods (as well as processing the returned values) are the same. <br />
<br />
The provided Visual Basic Timecard Test Client can only access the EService SOAP method to retrieve event details of a user, within a given time period, given the primary key of the user, the start date and the end date of the period. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/</div>Philipchttp://econz.org/index.php/Client_SoftwareClient Software2017-05-08T03:20:21Z<p>Philipc: </p>
<hr />
<div>{{MainSectionLinks}}<br />
<br />
This page documents the various client software applications that Econz Wireless provides to it's customers for integration purposes. If you wish to bypass this and go directly to the source code examples for developing your own integrations with Econz Wireless products, please go to our [[Downloads]] page.<br />
<br />
__TOC__<br />
<br />
== The EService Integrator ==<br />
<br />
Developed in house, this application is designed to simplify the process of connecting external system to EService. The Integrator is designed to read incoming XML messages from Emails, Files, or Microsoft Message Queue Messages, convert them to EService Jobs, and send them into EService. The Integrator can then monitor these jobs and send XML Emails, Files, and Messages out detailing any status changes or updates to jobs in EService, allowing external systems to receive near real time job monitoring information.<br />
<br />
The Integrator uses the SOAP interface to achieve this, but no knowledge of the SOAP interface is required to use the Integrator.<br />
<br />
== EService Test Clients ==<br />
<br />
=== Built in C Sharp (C#) ===<br />
<br />
The EService CSharp Test Client application is a complete test client in the sense that it is capable of running all of the EService SOAP methods as well as processing all of the data types returned by these SOAP methods respectively. It contains an internal data storage mechanism, i.e. Datasets to store the data in xml files within the application folder, that allows for progression and saving of job and task data and thus allowing users to effectively perform any function of the website via the application interface. It can also easily switch between different organisations. Please check back soon for instructions on how to request an organisation in our EService webserver. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService SOAP methods, i.e. those methods to interact with EService webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. It represents the coding required to link an external report or data management system with EService, and the source code is available to assist developers in creating their own linking modules to EService.<br />
For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels. <br />
<br />
The documentation for the client is here : [http://iweb.econz.co.nz/wiki/images/8/81/EService_CSharp_Full_Test_Client_Documentation_1.0.pdf C# Test Client Documentation].<br />
<br />
==== Visual Studio 2003 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Client is more limited in scope compared to its C Sharp alternative as it only focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of EService how to write Visual Basic .NET program to interact with EService webserver, i.e. how to invoke an EService SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other EService SOAP methods (as well as processing the returned values) are the same.<br />
<br />
The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2008 ====<br />
The Test clients built under Visual Studio 2008 are designed to run against the Microsoft .NET Framework 3.5 SP1. The 3.5 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
<br />
== Timecard Test Clients ==<br />
=== Built in C Sharp (C#) ===<br />
The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface. <br />
<br />
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating user events, teams, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling Timecard SOAP methods, i.e. those methods to interact with Timecard webserver.<br />
<br />
The source code of this test client application should be able to help current and potential users of Timecards write their own modules to interact with Timecard webserver. It represents the coding required to link an external report or data management system with Timecard, and the source code is available to assist developers in creating their own linking modules to Timecard.<br />
For example, should a developer need to develop a module to manage teams in Timecard webserver, he or she could have a look at the source code for the "Team Management" panel. <br />
<br />
==== Visual Studio 2003 ====<br />
The Timecard C# Full Test Client has been built to completely exercise all the functions and features of the Timecard SOAP API. It allows you to retrieve information about users events and hours of specified time intervals, and create new users and teams. Please check the [[Downloads]] page for more information about geting the source code and a test client installer.<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
=== Built in Visual Basic .Net ===<br />
<br />
The Visual Basic Test Clients is more limited in scope compared to its C Sharp alternative as it focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of Timecard how to write Visual Basic .NET program to interact with Timecard webserver, i.e. how to invoke an Timecard SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other Timecard SOAP methods (as well as processing the returned values) are the same. <br />
<br />
The provided Visual Basic Timecard Test Client can only access the EService SOAP method to retrieve event details of a user, within a given time period, given the primary key of the user, the start date and the end date of the period. <br />
<br />
==== Visual Studio 2003 ====<br />
<br />
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/<br />
<br />
==== Visual Studio 2005 ====<br />
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-04-25T05:49:41Z<p>Philipc: /* The Interface Definition */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here] and here is the [http://timecardwebtest.econz.com/axis/services/timecard1Soap?wsdl wsdl]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-04-20T20:46:01Z<p>Philipc: /* The Timecard SOAP API */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the Econz Timecard servers.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/GetUserDetailByLoginIDGetUserDetailByLoginID2017-04-04T05:29:49Z<p>Philipc: Created page with "== Method == GetUserDetailResult getUserDetailByLoginID(UserIDBean userID, String loginID) == Description == Gets the full set of details for a single user specified ..."</p>
<hr />
<div>== Method ==<br />
[[GetUserDetailResult]] getUserDetailByLoginID([[UserIDBean]] userID, String loginID)<br />
<br />
== Description ==<br />
Gets the full set of details for a single user specified by their LoginID.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|loginID<br />
|The Login ID (user name) of the user to get.<br />
|}<br />
<br />
== Return Value ==<br />
[[GetUserDetailResult]]</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-04-04T05:27:32Z<p>Philipc: Added getUserDetailByLoginID</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetailByLoginID]]<br />
|Gets all the details of the user as specified by their Login ID (user name).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/AddTaskWithAddressAddTaskWithAddress2017-03-29T19:39:33Z<p>Philipc: /* Return Value */</p>
<hr />
<div>== Method ==<br />
AddNewTaskResult addTaskWithAddress([[UserIDBean]] userID)<br />
<br />
== Description ==<br />
Add this new detailed task to the organisation.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|[[DetailedTaskWithAddress]]<br />
|detailedTask<br />
|New detailed task to add.<br />
|}<br />
<br />
== Return Value ==<br />
AddNewTaskResult<br />
<br />
----<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087895776 auto generated] doc.''</div>Philipchttp://econz.org/index.php/GetUserSummariesGetUserSummaries2017-03-22T21:55:07Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
GetUserSummariesResult getUserSummaries([[UserIDBean]] userID)<br />
<br />
== Description ==<br />
Gets a summary for all users in the organisation.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|}<br />
<br />
== Return Value ==<br />
GetUserSummariesResult<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087893184 auto generated] doc.''</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-03-15T07:08:16Z<p>Philipc: /* Various Maintenance Functions */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the given Task (specified by the taskName).<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-03-15T07:06:16Z<p>Philipc: Added updateTaskManager</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087877664 updateTaskManager]<br />
|UserIDBean, taskName, managerPK<br />
|Updates the 'TaskManager' (i.e. specifically a user who is a 'Manager' type) associated with the Task.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/AddTaskForManagerAddTaskForManager2017-03-15T06:57:00Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
AddNewTaskResult addTaskForManager([[UserIDBean]] userID, managerPK, detailedTask)<br />
<br />
== Description ==<br />
Add this new task specifically to the given Manager.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|managerPK<br />
|The user PK of the manager to add<br />
|---- bgcolor=#EDEDFF<br />
|[[DetailedTaskWithAddress]]<br />
|detailedTask<br />
|New detailed task to add.<br />
|}<br />
<br />
== Return Value ==<br />
AddNewTaskResult<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087888016 auto generated] doc.''</div>Philipchttp://econz.org/index.php/AddTaskForManagerAddTaskForManager2017-03-15T06:55:37Z<p>Philipc: Fix description</p>
<hr />
<div>== Method ==<br />
AddNewTaskResult addTaskForManager([[UserIDBean]] userID, managerPK, detailedTask)<br />
<br />
== Description ==<br />
Add this new task specifically to the given Manager.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|managerPK<br />
|The user PK of the manager to add<br />
|---- bgcolor=#EDEDFF<br />
|[[DetailedTaskWithAddress]]<br />
|detailedTask<br />
|New detailed task to add.<br />
|}<br />
<br />
== Return Value ==<br />
AddNewTaskResult<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448837712 auto generated] doc.''</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-03-15T06:52:49Z<p>Philipc: Added updateTaskDetails</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087880272 updateTaskDetails]<br />
|UserIDBean, taskName, taskDetails<br />
|Sets/updates the task details.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-03-15T05:00:49Z<p>Philipc: Added renameTask</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45927087882816 renameTask]<br />
|UserIDBean, oldTaskName, newTaskName<br />
|Update the task/customer name.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipchttp://econz.org/index.php/UpdateUserUpdateUser2017-02-08T01:42:40Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
[[UpdateUserResult]] updateUser([[UserIDBean]] userID, [[UserBean]] user)<br />
<br />
== Description ==<br />
Updates an existing user with new details.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|[[UserBean]]<br />
|user<br />
|The set of new details to update the user with.<br />
|}<br />
<br />
== Return Value ==<br />
[[UpdateUserResult]]<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448957184 auto generated] doc.''</div>Philipchttp://econz.org/index.php/CreateUserCreateUser2017-02-08T01:41:24Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
[[CreateUserResult]] createUser([[UserIDBean]] userID, [[UserBean]] user, String password)<br />
<br />
== Description ==<br />
Creates a new user for the organisation, using the details noted in the [[UserBean]].<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|[[UserBean]]<br />
|user<br />
|The details of the new user to create.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|password<br />
|The password the user will use to log on with on the website.<br />
|}<br />
<br />
== Return Value ==<br />
[[CreateUserResult]]<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448962272 auto generated] doc.''</div>Philipchttp://econz.org/index.php/DeleteUserDeleteUser2017-02-08T01:40:09Z<p>Philipc: /* Return Value */</p>
<hr />
<div>== Method ==<br />
[[DeleteUserResult]] deleteUser([[UserIDBean]] userID, String userPK, int updateIndex)<br />
<br />
== Description ==<br />
Attempts to mark a specified user record as deleted on the server, thus permanently disabling the use of that user to logon.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|userPK<br />
|The primary key of the user record to delete.<br />
|---- bgcolor=#EDEDFF<br />
|int<br />
|updateIndex<br />
|The current update index of the user.<br />
|}<br />
<br />
== Return Value ==<br />
[[DeleteUserResult]]<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448952048 auto generated] doc.''</div>Philipchttp://econz.org/index.php/DeleteUserDeleteUser2017-02-08T01:39:47Z<p>Philipc: </p>
<hr />
<div>== Method ==<br />
[[DeleteUserResult]] deleteUser([[UserIDBean]] userID, String userPK, int updateIndex)<br />
<br />
== Description ==<br />
Attempts to mark a specified user record as deleted on the server, thus permanently disabling the use of that user to logon.<br />
<br />
== Parameters ==<br />
{| border=1<br />
!Type<br />
!Name<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[UserIDBean]]<br />
|userID<br />
|The admin username and password.<br />
|---- bgcolor=#EDEDFF<br />
|String<br />
|userPK<br />
|The primary key of the user record to delete.<br />
|---- bgcolor=#EDEDFF<br />
|int<br />
|updateIndex<br />
|The current update index of the user.<br />
|}<br />
<br />
== Return Value ==<br />
[[DeleteUserResult]]<br />
<br />
<br />
----<br />
<br />
<br />
''See also, [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578448952048 auto generated] doc.''</div>Philipchttp://econz.org/index.php/Timecard_Soap_APITimecard Soap API2017-02-08T01:36:06Z<p>Philipc: /* Methods to Retrieve Processed Data */</p>
<hr />
<div>== The Timecard SOAP API ==<br />
<br />
The Timecard SOAP API is similar to the [[EService Soap API]], in that it provides methods for retrieving, updating, and deleting data stored on the server.<br />
<br />
The API is published separately at the moment, as another interface for linking into the Timecard server, although there is some progress on integrating the two products together in a future release.<br />
<br />
== The Interface Definition ==<br />
<br />
Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found [http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html here] and even better the latest auto generated SOAP doc is available [http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html here]). Each function is called, passing in at least one parameter, a [[UserIDBean]]. This bean contains the user name and password of a previously registered Timecard User, with administrative rights. This ensures only authorised users are able to access the interface.<br />
<br />
=== Timecard User Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createUser]]<br />
|Creates a new user based on the user data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetail]]<br />
|Gets all the details of a specified user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserDetails]]<br />
|Gets all the details for all the users (returns an array of [[UserBean]]).<br />
|---- bgcolor=#EDEDFF<br />
|[[getUserSummaries]]<br />
|Returns a list of all users (including managers).<br />
|---- bgcolor=#EDEDFF<br />
|[[getManagerSummaries]]<br />
|Returns a list of just the managers.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUser]]<br />
|Updates a particular user with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateUserPassword]]<br />
|Updates a user's password.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteUser]]<br />
|Deletes an existing user.<br />
|---- bgcolor=#EDEDFF<br />
|[[getUnsynchronisedUsers]]<br />
|Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation.<br />
|---- bgcolor=#EDEDFF<br />
|[[ackUserSynchronisation]]<br />
|Acknowledges that synchronisation has been performed on the selected users.<br />
|}<br />
<br />
=== Timecard Field Device Management Functions ===<br />
{| border=1<br />
!Method<br />
!Summary<br />
|---- bgcolor=#EDEDFF<br />
|[[createFieldDevice (for Timecard)|createFieldDevice]]<br />
|Creates a new field device based on the field device data passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetail]]<br />
|Gets the full set of details for a specified field device.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetails]]<br />
|Gets the full set of details for all specified field devices.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDeviceDetailsUpdatedSince]]<br />
|Gets the full set of details for all field devices that have been updated since the specified date and time.<br />
|---- bgcolor=#EDEDFF<br />
|[[updateFieldDevice]]<br />
|Updates a field device with new details.<br />
|---- bgcolor=#EDEDFF<br />
|[[deleteFieldDevice]]<br />
|Marks a field device as deleted.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForName]]<br />
|Gets the primary key of a field device, based on the name passed in.<br />
|---- bgcolor=#EDEDFF<br />
|[[getFieldDevicePKForDeviceID]]<br />
|Gets the primary key of a field device, based on the device id passed in.<br />
|}<br />
<br />
=== Timecard functions to Retrieve Raw Event Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserEvents]<br />
|[[UserIDBean]], userPrimaryKey, start date, end date<br />
|For a given user in a selected period, retrieves clock in/out dates and times and task descriptions.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getAllUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getAllUserEvents]<br />
|[[UserIDBean]], start date, end date<br />
|Retrieves clock in/out dates and times and task descriptions for all users in a selected period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#EventBean | EventBean]]<br />
|[http://eservicewebtest.econz.com/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUnsynchronisedUserEvents(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar) getUnsynchronizedUserEvents]<br />
|[[UserIDBean]], [[SynchronisationBean | synchronisationID]], createdOnOrAfter<br />
|Retrieves array of [[#EventBean | EventBean]] (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.<br />
|---- bgcolor=#EDEDFF<br />
|return<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#ackUserEventSynchronisation(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.UserEventSynchronisationBean%5B%5D) ackUserEventSynchronization]<br />
|[[UserIDBean]], [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/UserEventSynchronisationBean.html UserEventSynchronizationBean]<br />
|Acknowledges that synchronization has been performed on the selected events.<br />
|}<br />
<br />
=== Methods to Retrieve Processed Data ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getUserHoursSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar) getUserHoursSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end<br />
|Gets the hourly breakdown for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#HourBreakdownBean | HourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar) getHourSummaries]<br />
|[[UserIDBean]], start, end<br />
|Hourly breakdowns for all users in the given time period.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary]<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user.<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBean | DetailedHourBreakdownBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries]<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedUserHourSummaryWithRateCode<br />
|[[UserIDBean]], UserPrimaryKey, start, end, showUserTZFlag<br />
|Gets the hourly breakdown, adhering to the [[IDI]] specification, for a single user. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedUserHourSummary(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedUserHourSummary] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#DetailedHourBreakdownBeanWithRateCode | DetailedHourBreakdownBeanWithRateCode]]<br />
|getDetailedHourSummariesWithRateCode<br />
|[[UserIDBean]], start, end, showUserTZFlag<br />
|Hourly breakdowns, adhering to the [[IDI]] specification, for all users in the given time period. Provided results include a customer specified rate code for the associated task/device combination. This method does not return an additional row if worker time covers two days(eg night shift). The [http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getDetailedHourSummaries(nz.co.econz.nads.soap2.UserIDBean,%20java.util.Calendar,%20java.util.Calendar,%20boolean) getDetailedHourSummaries] method returns two rows for this scenario for easy daily overtime calculation. <br />
|---- bgcolor=#EDEDFF<br />
|Array of Strings<br />
|[http://eservicewebtest.econz.com/SOAP/timecard_wsdl_doc.html#op.idm45578449000880 getUserTypes]<br />
|[[UserIDBean]]<br />
|Returns array of UserType Names (FYI - The 'Operations Manager' user type has a PK of 9).<br />
|---- bgcolor=#EDEDFF<br />
|Array of [[#OverTimeRuleBean | OverTimeRuleBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOvertimeRulesBean(nz.co.econz.nads.soap2.UserIDBean) getOvertimeRulesBean]<br />
|[[UserIDBean]]<br />
|Returns array of OverTimeRuleBean.<br />
|}<br />
<br />
=== Retrieving and updating Organisation Details ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|[[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean) getOrganisationDetail]<br />
|UserIDBean<br />
|Returns all details from admin screen (including standard open hours).<br />
|---- bgcolor=#EDEDFF<br />
|updateOrganisationDetailResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#updateOrganisationDetail(nz.co.econz.nads.soap2.UserIDBean,%20nz.co.econz.nads.timecard1.OrganisationDetailsBean) updateOrganisationDetail]<br />
|UserIDBean, [[#OrganisationDetailsBean | OrganisationDetailsBean]]<br />
|Updates all details on admin screen (including standard open hours).<br />
|}<br />
<br />
=== Various Maintenance Functions ===<br />
<br />
{| border=1<br />
!Returns<br />
!Method<br />
!Parameters<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToUserResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToUser(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToUser]<br />
|UserIDBean, userPrimaryKey, messageString<br />
|Sends a string message to the specified user.<br />
|---- bgcolor=#EDEDFF<br />
|wakeFieldDeviceResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeFieldDevice(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeFieldDevice]<br />
|UserIDBean, userPrimaryKey<br />
|Sends a message to the phone, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|getTeamListResponse<br />
|getTeamList<br />
|UserIDBean<br />
|Returns the list of teams.<br />
|---- bgcolor=#EDEDFF<br />
|createNewTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#createNewTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) createNewTeam]<br />
|UserIDBean, teamName, teamLeaderUserPrimaryKey<br />
|Creates a new team with the specified user as the team leader.<br />
|---- bgcolor=#EDEDFF<br />
|deleteTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) deleteTeam]<br />
|UserIDBean, teamName<br />
|Deletes the specified team. Members of this team should be reallocated to existing teams.<br />
|---- bgcolor=#EDEDFF<br />
|addUserToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addUserToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addUserToTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Adds the specified user to the specified team. Note that each user can only belong to one team.<br />
|---- bgcolor=#EDEDFF<br />
|removeUserFromTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeUserFromTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) removeUserFromTeam]<br />
|UserIDBean, teamName, userPrimaryKey<br />
|Removes the user from the team specified.<br />
|---- bgcolor=#EDEDFF<br />
|sendMessageToTeamResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#sendMessageToTeam(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) sendMessageToTeam]<br />
|UserIDBean, teamName, messageString<br />
|Sends a string message to all users in the specified team.<br />
|---- bgcolor=#EDEDFF<br />
|wakeTeamFieldDevicesResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#wakeTeamFieldDevices(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) wakeTeamFieldDevices]<br />
|UserIDBean, teamName<br />
|Sends a message to all phone devices, which forces the application to start and connect to the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddTasksToTeamResult<br />
|addTasksToTeam<br />
|UserIDBean, teamName, tasks<br />
|Add a list of tasks to the given team.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromTeamResult<br />
|deleteTasksFromTeam<br />
|UserIDBean, teamName, tasks<br />
|Remove a list of tasks from the given team.<br />
|---- bgcolor=#EDEDFF<br />
|AddSubTasksToTaskResult<br />
|addSubTasksToTaskAndTeam<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Add a list of subTasks to the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteSubTasksFromTaskResult<br />
|deleteSubTasksFromTask<br />
|UserIDBean, teamName, taskName, subTasks<br />
|Delete a list of subTasks from the given team's task.<br />
|---- bgcolor=#EDEDFF<br />
|DeleteTasksFromAllTeamsResponse<br />
|deleteTasksFromAllTeams<br />
|UserIDBean, tasks<br />
|Delete a list of tasks from all teams.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getSubtasksForTaskAndTeam<br />
|UserIDBean, teamName taskName<br />
|Gets the sub tasks list from the server for a given task and team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|getTasksForTeam<br />
|UserIDBean, teamName<br />
|Gets the tasks/customers list from the server for a given team.<br />
|---- bgcolor=#EDEDFF<br />
|Array of strings<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getTaskList(nz.co.econz.nads.soap2.UserIDBean) getTaskList]<br />
|UserIDBean<br />
|Gets the tasks/customers list from the server.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addNewTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) addNewTask]<br />
|UserIDBean, taskName<br />
|Adds a new task/customer to the server list.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskWithAddress]]<br />
|UserIDBean, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list with custom fields and address information included.<br />
|---- bgcolor=#EDEDFF<br />
|AddNewTaskResult<br />
|[[addTaskForManager]]<br />
|UserIDBean, managerPK, [[DetailedTaskWithAddress]]<br />
|Adds a new task/customer to the server list (with custom fields and address information included) and associate it with the specified Manager's UserPK.<br />
|---- bgcolor=#EDEDFF<br />
|UpdateTaskResult<br />
|[[updateTaskStartEnd]]<br />
|UserIDBean, taskID, start, end<br />
|Sets/updates the time period visibility of the given task. The task will be visible on mobile devices from the given start date to the given end date.<br />
|---- bgcolor=#EDEDFF<br />
|removeTaskResult<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#removeTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) removeTask]<br />
|UserIDBean, taskName<br />
|Remove task/customer from the server.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtaskToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtaskToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) addSubtaskToTask]<br />
|UserIDBean, taskName, subTaskName<br />
|Add a new subtask to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|addSubtasksToTask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#addSubtasksToTask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String%5B%5D) addSubtasksToTask]<br />
|UserIDBean, taskName, subTaskNames<br />
|Add new list of subtasks to an existing task in the server list.<br />
|---- bgcolor=#EDEDFF<br />
|deleteSubtask<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#deleteSubtask(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String,%20java.lang.String) deleteSubtask]<br />
|UserIDBean, taskName, subTaskName<br />
|Remove subtask with the provided name from the task with the name provided from the server list.<br />
|---- bgcolor=#EDEDFF<br />
|getSubtaskList<br />
|[http://eservice.econz.co.nz/SOAP/timecardsoap1/nz/co/econz/nads/timecard1/Timecard1Soap.html#getSubtaskList(nz.co.econz.nads.soap2.UserIDBean,%20java.lang.String) getSubtaskList]<br />
|UserIDBean, taskName<br />
|Get a list of subtasks for the task with the provided name from the server list.<br />
<br />
|---- bgcolor=#EDEDFF<br />
|setFieldWorkerUnionCode<br />
|setFieldWorkerUnionCode<br />
|UserIDBean, userPK, unionCode<br />
|Associte the specified unionCode for the provided userPK. The unionCode specified needs to be defined in the [https://eserviceweb.econz.com/timecard/do/union/list Manage Unions Page] in the Timecard Website.<br />
|---- bgcolor=#EDEDFF<br />
|addRateCode<br />
|addRateCode<br />
|UserIDBean, userPK, taskName, rateCode<br />
|Associate the specified rateCode for the provided userPK/taskName combination<br />
|---- bgcolor=#EDEDFF<br />
|deleteRateCode<br />
|deleteRateCode<br />
|UserIDBean, userPK, taskName<br />
|Remove the rateCode specified for the provided userPK/taskName combination<br />
|}<br />
<br />
=== Main Data Type Definitions ===<br />
<br />
==== EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|whenOccured<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|The date and time at which a clock in, clock out, start break, end break start task or end task event occurred<br />
|---- bgcolor=#EDEDFF<br />
|eventID<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the event<br />
|---- bgcolor=#EDEDFF<br />
|eventType<br />
|Enumerated String<br />
|9<br />
|N/A<br />
|One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userPK<br />
|String<br />
|9<br />
|N/A<br />
|Unique identifier for the user.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|}<br />
<br />
==== TaskEventBean extends EventBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|N/A<br />
|The task name associated with the TASK_START or TASK_END event.<br />
|}<br />
<br />
==== HourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|}<br />
<br />
==== DetailedHourBreakdownBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
<br />
==== DetailedHourBreakdownBeanWithRateCode ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userPrimaryKey<br />
|String<br />
|9<br />
|N/A<br />
|User Primary Key in Timecard.<br />
|---- bgcolor=#EDEDFF<br />
|userType<br />
|String<br />
|50<br />
|N/A<br />
|Describes the type of user.<br />
|---- bgcolor=#EDEDFF<br />
|userName<br />
|String<br />
|25<br />
|N/A<br />
|The name of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|deviceID<br />
|String<br />
|30<br />
|N/A<br />
|Device ID of the user who generated the event (unique identifier for the device).<br />
|---- bgcolor=#EDEDFF<br />
|dateStart<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the start event.<br />
|---- bgcolor=#EDEDFF<br />
|dateEnd<br />
|Date<br />
|N/A<br />
|N/A<br />
|The date/time of the end event.<br />
|---- bgcolor=#EDEDFF<br />
|timezone<br />
|String<br />
|25<br />
|N/A<br />
|The timezone of the user who generated the event.<br />
|---- bgcolor=#EDEDFF<br />
|startEvent<br />
|String<br />
|25<br />
|N/A<br />
|The start event type.<br />
|---- bgcolor=#EDEDFF<br />
|endEvent<br />
|String<br />
|25<br />
|N/A<br />
|The end event type.<br />
|---- bgcolor=#EDEDFF<br />
|teamName<br />
|String<br />
|50<br />
|No<br />
|The team name that the user belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|taskName<br />
|String<br />
|50<br />
|No<br />
|The task that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|subtaskName<br />
|String<br />
|50<br />
|No<br />
|The subtask that the event belongs to.<br />
|---- bgcolor=#EDEDFF<br />
|normalHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|normalSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|overTimeSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of a normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraHours<br />
|Int<br />
|0-24<br />
|N/A<br />
|The hours component of extra time in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraMinutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|The minutes component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|extraSeconds<br />
|Int<br />
|0-59<br />
|N/A<br />
|The seconds component of overtime in excess of overtime and the normal working day.<br />
|---- bgcolor=#EDEDFF<br />
|rateCode<br />
|String<br />
|50<br />
|N/A<br />
|Customer specified Rate Code setup for the provided device & task combination.<br />
|---- bgcolor=#EDEDFF<br />
|customFields<br />
|Array of [[#CustomField | CustomField]]<br />
|N/A<br />
|N/A<br />
|The custom fields that are belong to this task.<br />
|}<br />
==== OverTimeRuleBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|userTypeAppliedTo<br />
|String<br />
|50<br />
|N/A<br />
|User type this is applied to.<br />
|---- bgcolor=#EDEDFF<br />
|startDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule starts<br />
|---- bgcolor=#EDEDFF<br />
|endDate<br />
|[[Calendar]]<br />
|N/A<br />
|N/A<br />
|When the overtime rule ends. This may be null if there is no definite end date for the rule.<br />
|---- bgcolor=#EDEDFF<br />
|includeBreakInTimeWorked<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Defines if break time should be included in time worked calulations<br />
|---- bgcolor=#EDEDFF<br />
|overTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which overtime rule<br />
|---- bgcolor=#EDEDFF<br />
|extraTimeRule<br />
|[[#OverTimeBean | OverTimeBean]]<br />
|N/A<br />
|N/A<br />
|Which extratime rule<br />
|}<br />
<br />
==== OverTimeBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this overtime information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hoursPerDay<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime). <br />
|---- bgcolor=#EDEDFF<br />
|hoursPerWeek<br />
|[[#HoursPeriodBean | HoursPeriodBean]]<br />
|N/A<br />
|N/A<br />
|Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime). <br />
|}<br />
<br />
==== HoursPeriodBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|applicable<br />
|boolean<br />
|N/A<br />
|N/A<br />
|Determines if this hours period information is applicable or not.<br />
|---- bgcolor=#EDEDFF<br />
|hours<br />
|Int<br />
|0-168<br />
|N/A<br />
|Number of hours in this period.<br />
|---- bgcolor=#EDEDFF<br />
|minutes<br />
|Int<br />
|0-59<br />
|N/A<br />
|Numberof minutes in this period.<br />
|}<br />
<br />
==== OrganisationDetailsBean ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|The name of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|description<br />
|String<br />
|50<br />
|N/A<br />
|The description of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|accountNumber<br />
|String<br />
|25<br />
|N/A<br />
|The account number of the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactName<br />
|String<br />
|30<br />
|N/A<br />
|The name of the contact person for the organisation.<br />
|---- bgcolor=#EDEDFF<br />
|contactWorkPhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's work number.<br />
|---- bgcolor=#EDEDFF<br />
|contactMobilePhone<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's mobile number.<br />
|---- bgcolor=#EDEDFF<br />
|contactEmailAddress<br />
|String<br />
|30<br />
|N/A<br />
|The contact person's email address.<br />
|---- bgcolor=#EDEDFF<br />
|address1<br />
|String<br />
|200<br />
|N/A<br />
|Address line 1 for the organisation (street address)<br />
|---- bgcolor=#EDEDFF<br />
|address2<br />
|String<br />
|30<br />
|N/A<br />
|Address line 2 for the organisation (suburb/town)<br />
|---- bgcolor=#EDEDFF<br />
|address3<br />
|String<br />
|30<br />
|N/A<br />
|Address line 3 for the organisation (city)<br />
|---- bgcolor=#EDEDFF<br />
|address4<br />
|String<br />
|30<br />
|N/A<br />
|Address line 4 for the organisation (state/region)<br />
|---- bgcolor=#EDEDFF<br />
|locale<br />
|String<br />
|10<br />
|N/A<br />
|Locale of the organisation (made up of language, country and variant codes - see [http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html java doc] for more info)<br />
|}<br />
<br />
==== CustomField ====<br />
<br />
{| border=1<br />
!Name<br />
!Type<br />
!Size<br />
!Required<br />
!Description<br />
|---- bgcolor=#EDEDFF<br />
|name<br />
|String<br />
|25<br />
|N/A<br />
|Name of the custom field set up in timecard.<br />
|---- bgcolor=#EDEDFF<br />
|value<br />
|String<br />
|500<br />
|N/A<br />
|Value entered for the custom field.<br />
|}</div>Philipc