Versions Compared

Old Version 2

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Gibt die Liste aller öffentlich verfügbaren Workflows für Tourenelemente einer Firma zurück.

Beschreibung

Status
colourGreen
titleGET
 getget_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
formatRückgabeformatstring'csv' oder 'json'. Standard bei Nichtangabe ist 'csv'.nein
Rückgabewerte


Rückgabe

Es wird eine Zeichenkette zurückgegeben. Bei einem Fehler wird der "403 - Verboten: Zugriff verweigert." HTTP-Header gesendet..

CSV Format

Bei einer korrekten Anfrage werden die Berichtsdaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Danach folgen die Daten.

Metainformationen

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1
KodierungUTF-8

Spalten

Spalte

Beschreibung

NAMEName des Workflows
DESCRIPTIONausführliche Beschreibung des Workflows

JSON Format

Code Block
titleRückgabe JSON
[
	{
		"name":"Spezial Reinigung",
		"description":"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann. Schöne Sache das!"
	}
]

Beispielaufruf

Code Block
titleBeispielaufruf in CSV Format
http
https://map.yellowfox.de/rti/get_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv

Beispielantwort

Code Block
titleBeispielaufruf in CSV Format
"NAME";"DESCRIPTION"


"Spezial Reinigung";"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann.
Schöne Sache das!
"


JSON format

Sv translation
languageen

Returns the list of all public reports available workflows for tour elements of a company including the corresponding download links.

Description

get_report_list

Status
colourGreen
titleGET
 get_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY

Parameter

parameter

description

type

hint

mandatory

companyRTI company keystring
yes
importRTI import keystring
yes
formatresponse formatstring'csv' or'json'. Default is 'csv'.no


Return

values

A character string is returned. On error "403 - forbidden: access denied." http-header will be sent.


CSV format

On a correct request the report data will be sent as CSV (comma separated value). First line is the header with column names. Data is follwoing afterwards.

Meta information

separatorsemicolon ( ; )
text delimiterdouble quotes ( " )
line end0x0D 0x0A (CarriageReturn LineFeed)
headerline 1
encodingUTF-8

Columns

column

description

REPORTNAME
NAMEname of
report draft
REPORTRANGE_FROMreport range start
REPORTRANGE_TOreport range end
CREATE_DATEcreate date
REPORT_TYPE

numeric representation of report type:

1... daily usage report
2... daily total usage report
3... routes driven
4... hours of operation report
5... idle report
6... analog inputs
8... FMS/CAN - object comparison
9... timerecording (old)
10... speed report
11... fuel report
12... private drive report
15... FMS/CAN - object report
21... FMS/CAN - driver comparison
22... driver behaviour/ driving analysis
23... area-/cc-report
24... temperature recorder
25... insurance report
26... POI-report
27... tacho - timerecording (old)
29... driver - overspeed
30... expense report
31... telemetry report
32... timerecording (new)
34... driving license check
35... vehicle usage
36... tacho - timerecording (new)
37... activity report
38... trailer report

FORMATfile format, e.g. html, pdf, xls...
DOWNLOADLINK

link to generated file

Attention: Large Excel reports might be splitted into multiple files and will be returned as ZIP archive!

workflow
DESCRIPTIONverbose description of this workflow

JSON format

code
Code Block
titlereturn json
[
	{
		"reportnamename":"ZeiterfassungSpezial WerkstattReinigung",
		"reportrange_fromdescription":"2020-12-01 00:00:00",
		"reportrange_to":"2020-12-31 23:59:59",
		"create_date":"2021-01-01 07:04:53",
		"report_type":26,
		"format":"html",
		"downloadlink":"map.yellowfox.de/rc.php?i=REPORT_IDENTDas ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."
	}
]

Example call

http

Code Block
titlereturn in csv
https://map.yellowfox.de/rti/get_
report
tour_
list
workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv

Example response

Code Block
titlereturn in csv
"
REPORTNAME
NAME";"
REPORTRANGE_FROM
DESCRIPTION"
;"REPORTRANGE_TO";"CREATE_DATE";"REPORT_TYPE";"FORMAT";"DOWNLOADLINK"
"Zeiterfassung Werkstatt";"2020-12-01 00:00:00";"2020-12-31 23:59:59";"2021-01-01 07:04:53";"32";"html";"map.yellowfox.de/rc.php?i=REPORT_IDENT"
"tägliche Serie POI-Bericht";"2020-12-25 00:00:00";"2020-12-31 23:59:59";"2021-01-01 07:09:20";"26";"pdf";"map.yellowfox.de/rc.php?i=REPORT_IDENT

"Spezial Reinigung";"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."