get_tour_workflows.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

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

Beschreibung

GET get_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstringja
importRTI Importschlüsselstringja
formatRückgabeformatstring'csv' oder 'json'. Standard bei Nichtangabe ist 'csv'.nein

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

SpalteBeschreibung
NAMEName des Workflows
DESCRIPTIONausführliche Beschreibung des Workflows

JSON Format

Rückgabe JSON
[
{
"name":"Spezial Reinigung",
"description":"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."
}
]

Beispielaufruf

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

Beispielantwort

Beispielaufruf in CSV Format
"NAME";"DESCRIPTION"
"Spezial Reinigung";"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."