Timecard Soap API
(→Notes) |
(→The Interface Definition) |
||
| Line 8: | Line 8: | ||
Below are listed the various functions that make up the timecard API. Each function is called, passing in at least one parameter, a UserIDBean. This bean contains the user name and password of a previously registered EService User, with administrative rights. This ensures only authorised users are able to access the interface. | Below are listed the various functions that make up the timecard API. Each function is called, passing in at least one parameter, a UserIDBean. This bean contains the user name and password of a previously registered EService User, with administrative rights. This ensures only authorised users are able to access the interface. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Notes == | == Notes == | ||
Revision as of 22:31, 17 July 2005
Contents |
The timecard SOAP API
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.
The API is published seperately 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.
The Interface Definition
Below are listed the various functions that make up the timecard API. Each function is called, passing in at least one parameter, a UserIDBean. This bean contains the user name and password of a previously registered EService User, with administrative rights. This ensures only authorised users are able to access the interface.
Notes
Timecard SOAP API v1.0
Timecard functions to Retrieve Raw Event Data
| Returns | Method | Parameters | Summary |
|---|---|---|---|
| Array of EventObject | getUserEvents | UserIDBean, userPrimaryKey, start date, end date | For a given user in a selected period, retrieves clock in/out dates and times and task descriptions. |
getUserEvents() returns array of Event Objects (detailed further below) for a given user in a selected period, e.g. clock in/out dates and times and task descriptions
getAllUserEvents(UserIDBean, start date, end date) returns array of Event Objects for all users in a selected period
getUnsynchronizedEvents(UserIDBean, synchronisationID, createdOnOrAfter) Retrieves array of Event Objects (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization
ackEventSynchronization(UserIDBean, eventSynchronizationBean) Acknowledges that synchronization has been performed on the selected events
Timecard User Management Functions
| Method | Summary |
|---|---|
| createUser | Creates a new user based on the user data passed in. |
| getUserDetail | Gets all the details of a specified user. |
| updateUser | Updates a particular user with new details. |
| updateUserPassword | Updates a user's password. |
| deleteUser | Deletes an existing user. |
| getUnsynchronisedUsers | Retrieves all users who have not previously been synchronised and acknowledged, and all users that have changed since their last synchronisation. |
| ackUserSynchronisation | Acknowledges that synchronisation has been performed on the selected users. |
EService Field Device Management Functions
| Method | Summary |
|---|---|
| createFieldDevice | Creates a new field device based on the field device data passed in. |
| getFieldDeviceDetail | Gets the full set of details for a specified field device. |
| getFieldDeviceDetails | Gets the full set of details for all specified field devices. |
| getFieldDeviceDetailsUpdatedSince | Gets the full set of details for all field devices that have been updated since the specified date and time. |
| updateFieldDevice | Updates a field device with new details. |
| deleteFieldDevice | Marks a field device as deleted. |
| getFieldDevicePKForName | Gets the primary key of a field device, based on the name passed in. |
| getFieldDevicePKForDeviceID | Gets the primary key of a field device, based on the device id passed in. |
Methods to Retrieve Processed Data
getUserHoursSummary(UserIDBean, UserPrimaryKey, start, end) Returns single HourBreakdownObject
getHourSummaries(UserIDBean, start, end) Returns array of HourBreakdownObject
getUserTypeNames(UserIDBean) Returns array of UserType Names
getOvertimeRules(UserIDBean) Returns array of OverTimeRule
Main Data Type Definitions
EventObject Event Occurred Timestamp (the date and time at which a clock in, clock out, start break, end break start task or end task event occurred) Event ID Event Type (Clock in, Clock out, Start break, End break, Task start, Task end) Name of User DeviceID of User UserPrimaryKey UserType
TaskEventObject extends EventObject Task ID
HourBreakdownObject UserPrimaryKey UserType UserName Device ID Normal Hours as int Normal mins as int Normal seconds as int (always zero currently) Overtime Hours as int Overtime mins as int Overtime seconds as int (always zero currently) Extratime Hours as int Extratime mins as int Extratime seconds as int (always zero currently)
