TimeMapAPI


Click here for a complete list of operations.

getRosterList

Always use Test server for test and development. All usage restrictions on test is 200 requests. Url: https://testservice.timemap.dk/timemapapi.asmx
Description:Get Workplans and Periods
Note, Fair usage limit: 5 request per hour.
Parameters:
  • apikey (string): Mandatory. The apikey is specified in the Company settings. Please see menu Settings->Company
  • apipwd (string): Mandatory. The api password must be specified in the Company settings. Please see menu Settings->Company
  • username (string): Mandatory. Specify the username/email of the user/developer calling this method. The user must exists in the EmployeeList.
  • departmentno (string): Optional. Department number of the department to get data for.
  • departmentid (int): Optional. Internal TimeMap departmentid of the department to get data for.
  • fromdate (datetime): Optional. First date of the period (if not specified the days date is used. Format: yyyy.MM.dd)
  • todate (datetime): Option. Last day of the period (if not specified days date plus one month is used. Format: yyyy.MM.dd)
Result: RosterList
  • workplanid: Internal TimeMap Unique ID for the employee.
  • workplanname: Work Plan Name.
  • departmentid: Internal department id
  • workplan_created_date: Workplan created date (Format: yyyy.MM.dd HH:mm)
  • workplan_created_by: Name of the function (Project, Absence or Custom text)
  • workplan_modified_date: P = project, A = Absence
  • workplan_modified_by: Internal TimeMap ID for the project or absence.
  • empl_permissions: Subject text
  • employee_groups: Employee Groups that can swap, buy and sell
  • workplanperiodid: Internal TimeMap ID for the period
  • fromdate: Period start date (format: yyyy.MM.dd)
  • todate: Period end date (format: yyyy.MM.dd)
  • is_template: 1 = this is a template
  • template_deployed_to: Date for the template employment (Format: yyyy.MM.dd)
  • template_deploy_days_before: Number of days the template should be deployed
  • period_created_date: Date of the creation.
  • period_created_by: Creator
  • period_modified_date: Modified date
  • period_modified_by: Modified by

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TimeMapApi.asmx HTTP/1.1
Host: testservice.timemap.dk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/getRosterList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getRosterList xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
    </getRosterList>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getRosterListResponse xmlns="http://tempuri.org/">
      <getRosterListResult>string</getRosterListResult>
    </getRosterListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TimeMapApi.asmx HTTP/1.1
Host: testservice.timemap.dk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getRosterList xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
    </getRosterList>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getRosterListResponse xmlns="http://tempuri.org/">
      <getRosterListResult>string</getRosterListResult>
    </getRosterListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /TimeMapApi.asmx/getRosterList?apikey=string&apipwd=string&username=string HTTP/1.1
Host: testservice.timemap.dk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>