HomeCustomer ZoneSupportUsing Replicon Web Services

Replicon web services allow you to extract data from Replicon and use it in external applications. Data is called using HTTP protocols, and is returned in XML or other selected formats.

How to Use Replicon Web Services

Use the following steps to access web services manually. Or, you can adapt the following procedure to call web services programmatically.

  1. Log in to Replicon.

You must be logged in to Replicon to access the web service.

  1. Append the web service’s methods and parameters to the Replicon URL in your browser’s address bar. Use this format: 

[RepliconURL]/services/

[ServiceName.asmx]/

[MethodName]?

[Parameter1Name=Parameter1Value]&

[Parameter2Name=Parameter2Value]

Where…

RepliconURL

 Differs depending on the type of server you are using:

  • For SaaS (Replicon-hosted): http:// server or IP/company key

e.g. http:// hosted.webtimesheet.com/companyx/

  • For ISAPI IIS: http:// server or IP/cgi/rt.dll/timesheet

e.g. http:// smith:8083/cgi/rt.dll/timesheet/

  • For CGI IIS: http:// server or IP/cgi/rt.exe/timesheet

e.g. http:// smith:8083/cgi/rt.exe/timesheet/

  • For Internal web server: http:// server or IP/timesheet

e.g. http:// johnsmithxp:81/timesheet/

ServiceName

 Identifies the web service you are running

MethodName

Determines what records the web service returns

Is case sensitive

Parameters

 Limit the data returned

Method names and parameter values for each web service are described in the Available Services section below.

  1. Press Enter. The service will return the requested data.

 

Available Services

ReportService

Description

Use the ReportService web service to extract data from any Replicon report.

Request Method and Parameters

One method is available for the ReportService web service:

Method

This method…


GenerateReport
Returns data from a single Replicon report in the format you specify

For this method, you define the three parameters described below. All three parameters are required.

Parameter

Description of Parameter

Allowed Values


format
Specifies the output format of the extracted data

html – returns report data in HTML format

csv – returns report data in CSV format

msxml – returns report data in MS XML format

xml – returns report data in raw xml format


category
Specifies the name of the folder that contains the report whose data you want to extract

Any report folder name, as given on the Select a Report page

e.g. Time Reports or Administration Reports


name

Specifies the name of the report whose data you want to extract

The name of any report included in the category folder, as given on the Select a Report page

e.g. User Hours Details, if Time Reports is entered as the category (assuming default report location)

Response

The web service will return a text string containing the report data formatted as specified. You can output this string to a file of the appropriate format to save the data. The data returned will match your current settings (filters, fields, etc) for the report.

Examples

Example 1

To extract data from the License Seat Assignment report, located in your Administration Reports folder, enter the following in your URL:

[RepliconURL]/services/

ReportService.asmx/

GenerateReport?

format=html&

category=Administration Reports&

name=License Seat Assignments

In response, you will receive html-coded data, that matches your current settings for the License Seat Assignments report.

Example 2

You created a new report entitled My Team and saved it in the Time Reports folder. To extract data from the My Team report and save it in msxml format, enter the following in your URL:

[RepliconURL]/services/

ReportService.asmx/

GenerateReport?

format=html&

category=Time Reports&

name=My Team

In response, you will receive msxml-coded data that matches your current settings for the My Team report.

 

TimeOffBalanceReportService

Description

Use the time off balance web service to extract time off balance data from Replicon.

Request Methods and Parameters

Two methods are available for the Time Off Balance web service:

Method

This method…


GetTimeOffBalanceData
A time off balance record for each time off type that the specified user can book or enter time against

GetTimeOffBalanceDataForType
A single time off balance record for the specified time off type

For each method, you define 2 or 3 parameters (depending on the method). All parameters available for a method are required.

Parameter

Description of Parameter


UserLoginName
The login name of the user whose data you want returned.

AsOfDate
The date whose balance you want returned; that is, the balance returned will be the time off balance at that date.

TimeOffTypeName1
The name of the time off type whose balance you want returned.

1 Available in the GetTimeOffBalanceDataForType only.

Response

Most of the fields returned by the Time Off Balance web service match – in both name and data values – fields found in the Time Off Balance report. However, to provide complete time off balance data, the web service also includes balance values that match those displayed in the time off calendar.

The following data relationships are used to display the web service data:

Parameter

Description of Parameter

Allowed Values


Time Off Calendar

Remaining Days

Remaining Hours

RemainingDays

RemainingHours

Taken Days

Taken Hours

TakenToResetDays

TakenToResetHours


Time Off Balance Report

Time Off Remaining (Days)

Time Off Remaining (Hrs)

BalanceDays

BalanceHours

Time Off Taken (Days)

Time Off Taken (Hrs)

TakenToDateDays

TakenToDateHours

Examples

Example 1

To extract Sally’s vacation time off balance as of March 15, 2010, enter the following in your URL:

[RepliconURL]/services/

TimeOffBalanceReportService.asmx/

GetTimeOffBalanceDataForType?

userLoginName=sally&

timeoffTypeName=vacation&

asOfDate=March 15, 2010

Example 2

To extract John’s sick time off balance as of February 13, 2010, enter the following in your URL:

[RepliconURL]/services/

TimeOffBalanceReportService.asmx/

GetTimeOffBalanceDataForType?

userLoginName=john&

timeoffTypeName=sick&

asOfDate=February 13, 2010