...
This section describes various scenarios of how the Web Services can be used.
getModifiedItemsWithRefCode()
...
Authentication
Before you can call any other InTime Web Service method you must first call the authenticate() method. Providing valid credentials to this method will return an authentication token that must be provided with all other Web Service calls.
Modified Items
getModifiedItems() and getModifiedItemsWithRefCode() functions return a list of items that have been updated since a specific date and time. This is useful where you wish to maintain a copy of various entities in an external system.
...
With version 2.0 it is now possible to create data in InTime via the Web Services. This includes the following entities: Worker, Client, Manager, Consultant, Provider, Placement and Timesheet. These mostly take the form of createOrUpdateXXX as this allows the same method to be used to create the entity if it doesn't exist or update it if it does. Examples are: createOrUpdateWorker(), createorUpdatePlacement() and createOrUpdateProvider()Timesheet processes
Timesheets
updateTimesheet() method will create a new timesheet Timesheet or update an existing one if it exists in Draft status. The timesheet Timesheet will be saved with Draft status. The Timesheet object you supply to this method must contain all the necessary data which includes a valid Placement reference, the start and Period End Dates date and one or more Shifts. Each shift Shift must reference a valid Rate from the Placement, the time or decimalTime worker or a Decimal value and the Date on which it was worked. It will normally be necessary to retrieve the details of the Placement the Timesheet relates to in order to correctly complete all the required fields.
submitTimesheet() would then be called to submit it the Timesheet for approval once it has all the necessary time (Shifts) added to it.
rejectTimesheet() or approveTimesheet() are then used to process the approval.
...
revertTimesheet() can also be used to revert a Submitted or Approved status Timesheet if required. This has exactly the same result as reverting a Timesheet though the InTime UI.
Single Sign On
getSingleSignOnToken() can be used to log in to InTime using an existing InTime User account. This method returns a token that you can then append to any valid InTime URL and it will allow you to retrieve the page as if you were logged into the system directly. This means you can embed InTime pages within another web site or retrieve other data.
Other methods
The interface also provides various other methods. Some examples:
getMissingTimesheetsForPlacement() identifes any periods within the specified range that do not contain an approved timesheet. The reponse will include a status that indicates if it is Missing, Draft or Submitted.
getAllPayElements() returns a list of all Pay Elements present in the system.
getURLForContractorsPayslip() retrieves the URL to viewing a workers Payslips. *InPay Linked systems only
Getting started
Code Examples
- authenticate
- ? creatOrUpdateWorker
- createOrUpdatePlacement
- getPlacement
- update timesheet
- ? submitTimesheet
- ? approveTimesheet
- readinvoices for timesheet
- getsingle signon token
/********************************************
...
//update Integration home page to link to new area and adjust single sign on section as necessary
scenarios and uses
...
...
examples (Java)
Build stub code using wsdl2Java
- authenticate
- ? creatOrUpdateWorker
- createOrUpdatePlacement
- getPlacement
- update timesheet
- ? submitTimesheet
- ? approveTimesheet
- readinvoices for timesheet
- getsingle signon token
Example in .net ?
Move API docs on to documentation domain
...