TimeMapAPI


Click here for a complete list of operations.

ImportWorkplan

Always use Test server for test and development. All usage restrictions on test is 200 requests. Url: https://testservice.timemap.dk/timemapapi.asmx
Description:Used for importing/updatering workplans
Note, Fair usage limit: 5 request per workplan per hour.
Parameters:apikey (string): The apikey is specified in the Company settings. Please see menu Settings->Company

apipwd (string): The api password must be specified in the Company settings. Please see menu Settings->Company

username (string): Specify the username/email of the user/developer calling this method. The user must exists in the EmployeeList.

csvfile (base64Binary): The workplan data to be imported. Please see below.

C# Code Example:

  • Add a service reference to https://service.timemap.dk/TimeMapAPI.asmx?WSDL - TimeMapAPI.TimeMapApiSoap
  • Use the service reference as described below


using (var client = new YourNameSpace.TimeMapApiSoap.TimeMapAPISoapClient("TimeMapAPISoap"))
{
     sbMsg.AppendLine(client.ImportWorkplan("YourAPIKEY", "YourAPIPassword", "ValidUserName", System.Text.Encoding.GetEncoding("iso-8859-15").GetBytes(csvFile)));
}
CsvFile:The csvfile must have the columns specified below. No header allowed. Delimiter is ';' and text columns must be in double quotes.

Column description (english):
  1. Name of the workplan (varchar). Must exists in TimeMap
  2. Department number (varchar) *. Must exists in TimeMap
  3. Workplan start date (date yyyy.MM.dd)
  4. Workplan end date (date yyyy.MM.dd)
  5. Workplan section name (varchar) *
  6. Employee number (varchar). Must exists in TimeMap
  7. Employee sortorder (int) *
  8. Workdate (date yyyy.MM.dd)
  9. Work Start time (time HH:mm)
  10. Work End time (time HH:mm)
  11. Workbreak start time (time HH:mm) *
  12. Workbreak end time (time HH:mm) *
  13. Employee Agreement name (varchar) *. Must exists in TimeMap
  14. On Call (int) **
  15. Comment (varchar) *

Comments:
*) Optional fields.
**) Following values is allowed for On Call specification:
  • No value: Not On Call
  • 1: On Call before work start time (midnight to work start)
  • 2: On Call after work start time (work end to midnight)
  • 3: On Call before & after work start/end time (midnight to work start and work end to midnight)


Column description (danish):
  1. Vagplan navn (varchar). Vagtplanen skal være oprettet i TimeMap
  2. Afdelingsnr (varchar) *. Afdeling skal være oprettet i TimeMap
  3. Vagtplan startdato (dato)
  4. Vagplan slutdato (dato)
  5. Sektion navn (varchar) *
  6. Medarbejder nr (varchar)
  7. Medarbejder sortering (int) *
  8. Vagtdato (dato)
  9. Starttid (tid)
  10. Sluttid (tid)
  11. Pause start (tid) *
  12. Pause slut (tid) *
  13. Lønaftale navn (varchar) *. Lønaftale skal være oprettet i TimeMap
  14. Rådighedsvagt (int) **
  15. Kommentar (varchar) *

Kommentarer:
*) Disse felter kan være tomme.
**) Rådighedsvagt kan have følgende værdier:
  • Blank: Ingen rådighedsvagt
  • 1: Rådighedsvagt før
  • 2: Rådighedsvagt efter
  • 3: Rådighedsvagt før & efter

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

<?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>
    <ImportWorkplan xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <csvfile>base64Binary</csvfile>
    </ImportWorkplan>
  </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>
    <ImportWorkplanResponse xmlns="http://tempuri.org/">
      <ImportWorkplanResult>string</ImportWorkplanResult>
    </ImportWorkplanResponse>
  </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>
    <ImportWorkplan xmlns="http://tempuri.org/">
      <apikey>string</apikey>
      <apipwd>string</apipwd>
      <username>string</username>
      <csvfile>base64Binary</csvfile>
    </ImportWorkplan>
  </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>
    <ImportWorkplanResponse xmlns="http://tempuri.org/">
      <ImportWorkplanResult>string</ImportWorkplanResult>
    </ImportWorkplanResponse>
  </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/ImportWorkplan?apikey=string&apipwd=string&username=string&csvfile=string&csvfile=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>