TimeMapAPI


Click here for a complete list of operations.

getRosterDetails

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 Workplan Details
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.
  • workplanperiodid (string): Mandatory. Internal TimeMap ID for the Workplan Period. Get the id's for Workplan Periods by calling getRosterList
Result: RosterDetails
  • workplanid: Internal TimeMap Unique ID for the employee.
  • workplanperiodid: Work Plan Period id.
  • employeeid: Internal TimeMap employee id. If negative no employee is attached to the shift (open shifts)
  • worktimefrom: Shift start date/time (Format: yyyy.MM.dd HH:mm)
  • worktimeto: Shift end date/time (Format: yyyy.MM.dd HH:mm)
  • workbreakgroupname: Workbreaks
  • employeeagreementname: Employee Agreeement attached to the shift. If empty employee standard agreements is used.
  • absencename: The absence is any
  • ratepayment: Ratepayments
  • notes: Notes (as html)
  • employeename: Employee name
  • oncall: If the employee is on call
  • abscolor: Absence color
  • employee_hiredate: Employee hiredate (Format: yyyy.MM.dd)
  • employee_enddate: Employee termination date (Format: yyyy.MM.dd)
  • workplan_startdate: Start of the workplan period (Format: yyyy.MM.dd)
  • workplan_enddate: End of the workplan period (Format: yyyy.MM.dd)
  • workplanname: Workplan Name
  • sectionname: Workplan Section Name

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/getRosterDetails"

<?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>
    <getRosterDetails xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <workplanperiodid>string</workplanperiodid>
    </getRosterDetails>
  </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>
    <getRosterDetailsResponse xmlns="http://tempuri.org/">
      <getRosterDetailsResult>string</getRosterDetailsResult>
    </getRosterDetailsResponse>
  </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>
    <getRosterDetails xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <workplanperiodid>string</workplanperiodid>
    </getRosterDetails>
  </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>
    <getRosterDetailsResponse xmlns="http://tempuri.org/">
      <getRosterDetailsResult>string</getRosterDetailsResult>
    </getRosterDetailsResponse>
  </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/getRosterDetails?apikey=string&apipwd=string&username=string&workplanperiodid=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>