Timecard Soap API

From
(Difference between revisions)
Jump to: navigation, search
m (http://flheddin.qsh.eu/ettari-1872.html)
m (http://brc4tdro.is-the-boss.com/page174.html)
Line 1: Line 1:
 +
[http://brc4tdro.is-the-boss.com/page174.html readiris cracks] [http://huruple.qsh.eu/20081227-sexy-woman-smoking.htm sexy woman smoking video] [http://huruple.qsh.eu/20090103-silver-spring-md.htm silver spring md movie theater] [http://qasletop.is-the-boss.com/sitemap.html sitemap] [http://flheddin.qsh.eu/wgetcdee-166.html super millionaire video]
 
[http://flheddin.qsh.eu/ettari-1872.html prince charming movie quotes] [http://brc4tdro.is-the-boss.com/page162.html aoe rise of rome no cd] [http://fademon.0lx.net/article-842.htm ping pong movie torrent] [http://dronoubr.0lx.net/movie-dvd-of-2006.html movie dvd of 2006] [http://betheres.qsh.eu/comment-440.htm aviator trailer movie]  
 
[http://flheddin.qsh.eu/ettari-1872.html prince charming movie quotes] [http://brc4tdro.is-the-boss.com/page162.html aoe rise of rome no cd] [http://fademon.0lx.net/article-842.htm ping pong movie torrent] [http://dronoubr.0lx.net/movie-dvd-of-2006.html movie dvd of 2006] [http://betheres.qsh.eu/comment-440.htm aviator trailer movie]  
 
[http://sakonze.qsh.eu/nrlifi-1983.html snl key party video clip] [http://spfortne.qsh.eu/20081231-scarriest-movies.html scarriest movies ever] [http://faquafav.is-the-boss.com/text-971.htm inspirational posters jokes] [http://cnavieltz.strefa.pl/comment-372.htm phantom planet video california] [http://ettaelt.strefa.pl/news-1536.html refrigeration training videotapes]  
 
[http://sakonze.qsh.eu/nrlifi-1983.html snl key party video clip] [http://spfortne.qsh.eu/20081231-scarriest-movies.html scarriest movies ever] [http://faquafav.is-the-boss.com/text-971.htm inspirational posters jokes] [http://cnavieltz.strefa.pl/comment-372.htm phantom planet video california] [http://ettaelt.strefa.pl/news-1536.html refrigeration training videotapes]  

Revision as of 10:20, 11 January 2009

readiris cracks sexy woman smoking video silver spring md movie theater sitemap super millionaire video prince charming movie quotes aoe rise of rome no cd ping pong movie torrent movie dvd of 2006 aviator trailer movie snl key party video clip scarriest movies ever inspirational posters jokes phantom planet video california refrigeration training videotapes sitemap se7en movie isohunt torrentspy maple8 serial adult free game hentai movie online pic adobe after effects trial crack launched movie film volta cipher relationship advice lingerie video samples ratings of baby video monitor eric prydes video april flower movie movie northwest passage sitemap top maple story video clip rave movie theatre peoria il silent hill movie review public sharefolder crack movie munich trailer amateur blog video xxx picture of a movie stub macgourmet crack index intervideo home theater 2 key generator movie selleck tom western madoka ozawa videos activation norton systemworks 2005 mclaren f1 top speed video asscrack.com http pink video get the party started asian cum hardcore movie shot rammstein video clips image of journeyman electrical license movie wimbledon last of the mohicans movie review movie coming to dvd oklahoma bombing videos top muffdiving videos adams song video blink 182 pacers videos sunshine movie theatre ice cube it was a good day video sky lopez video clip sitcdellao

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 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.

The Interface Definition

Below is a summary of the important functions that make up the Timecard API (a full java doc style specification can be found 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.

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.

Timecard 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.

Timecard functions to Retrieve Raw Event Data

Returns Method Parameters Description
Array of EventBean 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.
Array of EventBean getAllUserEvents UserIDBean, start date, end date Retrieves clock in/out dates and times and task descriptions for all users in a selected period.
Array of EventBean getUnsynchronizedEvents UserIDBean, synchronisationID, createdOnOrAfter Retrieves array of EventObjectBean (detailed further below) that have not previously been synchronized and acknowledged and all events that have changed since their last synchronization.
return ackEventSynchronization UserIDBean, EventSynchronizationBean Acknowledges that synchronization has been performed on the selected events.

Methods to Retrieve Processed Data

Returns Method Parameters Description
HourBreakdownBean getUserHoursSummary UserIDBean, UserPrimaryKey, start, end Gets the hourly breakdown for a single user.
Array of HourBreakdownBean getHourSummaries UserIDBean, start, end Hourly breakdowns for all users in the given time period.
Array of Strings getUserTypes UserIDBean Returns array of UserType Names.
Array of OverTimeRuleBean getOvertimeRulesBean UserIDBean Returns array of OverTimeRuleBean.

Retrieving and updating Organisation Details

Returns Method Parameters Description
OrganisationDetailsBean getOrganisationDetail UserIDBean Returns all details from admin screen (including standard open hours).
updateOrganisationDetailResult updateOrganisationDetail UserIDBean, OrganisationDetailsBean Updates all details on admin screen (including standard open hours).

Various Maintenance Functions

Returns Method Parameters Description
sendMessageToUserResult sendMessageToUser UserIDBean, userPrimaryKey, messageString Sends a string message to the specified user.
wakeFieldDeviceResult wakeFieldDevice UserIDBean, userPrimaryKey Sends a message to the phone, which forces the application to start and connect to the server.
createNewTeamResult createNewTeam UserIDBean, teamName, teamLeaderUserPrimaryKey Creates a new team with the specified user as the team leader.
deleteTeamResult deleteTeam UserIDBean, teamName Deletes the specified team. Members of this team should be reallocated to existing teams.
addUserToTeamResult addUserToTeam UserIDBean, teamName, userPrimaryKey Adds the specified user to the specified team. Note that each user can only belong to one team.
removeUserFromTeamResult removeUserFromTeam UserIDBean, teamName, userPrimaryKey Removes the user from the team specified.
sendMessageToTeamResult sendMessageToTeam UserIDBean, teamName, messageString Sends a string message to all users in the specified team.
wakeTeamFieldDevicesResult wakeTeamFieldDevices UserIDBean, teamName Sends a message to all phone devices, which forces the application to start and connect to the server.
Array of strings getTaskList UserIDBean Gets the tasks/customers list from the server.
addNewTaskResult addNewTask UserIDBean, taskName Adds a new task/customer to the server list.
removeTaskResult removeTask UserIDBean, taskName Remove task/customer from the server.

Main Data Type Definitions

EventBean

Name Type Size Required Description
whenOccured Calendar N/A N/A The date and time at which a clock in, clock out, start break, end break start task or end task event occurred
eventID String 9 N/A Unique identifier for the event
eventType Enumerated String 9 N/A One of the following: CLOCK_IN, CLOCK_OUT, TASK_START, TASK_END, BREAK_START, BREAK_END.
userName String 25 N/A The name of the user who generated the event.
deviceID String 30 N/A Device ID of the user who generated the event (unique identifier for the device).
userPK String 9 N/A Unique identifier for the user.
userType String 50 N/A Describes the type of user.

TaskEventBean extends EventBean

Name Type Size Required Description
taskName String 50 N/A The task name associated with the TASK_START or TASK_END event.

HourBreakdownBean

Name Type Size Required Description
userType String 50 N/A Describes the type of user.
userName String 25 N/A The name of the user who generated the event.
deviceID String 30 N/A Device ID of the user who generated the event (unique identifier for the device).
userName String 25 N/A The name of the user who generated the event.
normalHours Int 0-24 N/A The hours component of a normal working day.
normalMinutes Int 0-59 N/A The minutes component of a normal working day.
normalSeconds Int 0-59 N/A The seconds component of a normal working day.
overTimeHours Int 0-24 N/A The hours component of overtime in excess of a normal working day.
overTimeMinutes Int 0-59 N/A The minutes component of overtime in excess of a normal working day.
overTimeSeconds Int 0-59 N/A The seconds component of overtime in excess of a normal working day.
extraHours Int 0-24 N/A The hours component of extra time in excess of overtime and the normal working day.
extraMinutes Int 0-59 N/A The minutes component of overtime in excess of overtime and the normal working day.
extraSeconds Int 0-59 N/A The seconds component of overtime in excess of overtime and the normal working day.

OverTimeRuleBean

Name Type Size Required Description
userTypeAppliedTo String 50 N/A User type this is applied to.
startDate Calendar N/A N/A When the overtime rule starts
endDate Calendar N/A N/A When the overtime rule ends. This may be null if there is no definite end date for the rule.
includeBreakInTimeWorked boolean N/A N/A Defines if break time should be included in time worked calulations
overTimeRule OverTimeBean N/A N/A Which overtime rule
extraTimeRule OverTimeBean N/A N/A Which extratime rule

OverTimeBean

Name Type Size Required Description
applicable boolean N/A N/A Determines if this overtime information is applicable or not.
hoursPerDay HoursPeriodBean N/A N/A Defines the limit of normal work per day (anything over this is considered as a form of overtime or extratime).
hoursPerWeek HoursPeriodBean N/A N/A Defines the limit of normal work per week (anything over this is considered as a form of overtime or extratime).

HoursPeriodBean

Name Type Size Required Description
applicable boolean N/A N/A Determines if this hours period information is applicable or not.
hours Int 0-168 N/A Number of hours in this period.
minutes Int 0-59 N/A Numberof minutes in this period.

OrganisationDetailsBean

Name Type Size Required Description
name String 25 N/A The name of the organisation.
description String 50 N/A The description of the organisation.
accountNumber String 25 N/A The account number of the organisation.
contactName String 30 N/A The name of the contact person for the organisation.
contactWorkPhone String 30 N/A The contact person's work number.
contactMobilePhone String 30 N/A The contact person's mobile number.
contactEmailAddress String 30 N/A The contact person's email address.
address1 String 200 N/A Address line 1 for the organisation (street address)
address2 String 30 N/A Address line 2 for the organisation (suburb/town)
address3 String 30 N/A Address line 3 for the organisation (city)
address4 String 30 N/A Address line 4 for the organisation (state/region)
locale String 10 N/A Locale of the organisation (made up of language, country and variant codes - see java doc for more info)
Personal tools
MediaWiki Appliance - Powered by TurnKey Linux