get_timerecording.asp

Last modified by YellowFox_RD on 2024/12/19 10:11

Table of Contents

Description
Parameter
Return
Example calls

Compatibility
This function is intended to be used with timerecording V2
If you are using the newer V3 version, please use get_timerecording.php

Returns all timerecording bookings within desired timerange.

Description

GET get_timerecording.asp?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&begin=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&mode=CSV&version=2

Parameter

Parameter	Description	Type	Note	Mandatory
company	RTI company key	string		yes
import	RTI import key	string		yes
begin	output start time	string	the output timerange is limited to 31 days	yes
end	output end time	string	the output timerange is limited to 31 days	yes
mode	output format	string	valid output formats CSV RSCT BOTIME	yes
version	alternative CSV output	integer	a value of "2" add geocoordinates for output	no
date_query	which date column is base for date query	string	'insert' (default) : date of proceed 'gps' : date of timerecording message	no

Return

A string will be returned. In case of error "ERROR:Description".

Reiner SCT Format

The returning data matching the specification of Reiner SCT import definition.

Botime Format

The returning data matching the specification of BOTIME. A TXT file will be returned. The requested date is based on timerecording date and not the date of message processing.

CSV Format

On success, the data will be delivered in csv (comma seperated values) format. The first line always is defined as head with column names. The following rows containing the booking data.

Meta informations

Separator	Semicolon ( ; )
Delimiter	Double quote ( " )
Line break	0x0D 0x0A (CarriageReturn LineFeed)
Header	Row 1
Encoding	Windows-1252

Columns

Column	Description
DATETIME	Date	format DD.MM.YYYY HH:MM:SS
ACTION	Short booging type definition	K, G, X, Y, B, E
ACTIONTEXT	Description text for booking as defined	Definition set at Administration -> Timerecording
POSITION	Aufgelöster Positionstext
AREA	Cost centers/areas, as defined for this Position	delimiter: "%\|%" structure: cost center + space + area name example: "101 construction site A%\|%201 construction site B%\|%456 customer smith"
DRIVERKEY	personal key of person who did the booking
DRIVERNAME	name of person who did the booking
CAR	portal Name of object, where the booking was done
LAT	Latitude	example: "51.4" only for "mode=CSV" and "version=2"
LON	Longitude	example: "13.1" only for "mode=CSV" and "version=2"

Example

return in csv
"DATETIME";"ACTION";"ACTIONTEXT";"POSITION";"AREA";"DRIVERKEY";"DRIVERNAME";"CAR";"LAT";"LON";
"01.10.2015 08:00:00";"K";"work start";"Examplestreet 17, 01234 Examplecity";"head office";"12345";"Sam Smith";"MU-YF 1";"51.4";"13.1";
"01.10.2015 08:00:00";"X";"pause start";"Testroad 23, 91234 Testvillage";"John Doe GmbH";"12345";"Sam Smith";"MU-YF 1";"52";"11.3";

Example calls

get bookings with geo coordinates
https://map.yellowfox.de/rti/get_timerecording.asp?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&begin=20151102000000&end=20151108235959&mode=CSV&version=2

get bookings for Reiner SCT import
https://map.yellowfox.de/rti/get_timerecording.asp?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&begin=20151026000000&end=20151101235959&mode=RSCT