Wiki-Quellcode von get_tour_workflows.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Gibt die Liste aller öffentlich verfügbaren Workflows für Tourenelemente einer Firma zurück.
6 = Beschreibung =
7 **(% class="green mark" %)GET(%%) get_tour_workflows.php****?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY//
8 = Parameter =
9 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 |company|RTI Firmenschlüssel|string||ja
11 |import|RTI Importschlüssel|string||ja
12 |format|Rückgabeformat|string|'csv' oder 'json'. Standard bei Nichtangabe ist 'csv'.|nein
13
14 = Rückgabe =
15 Es wird eine Zeichenkette zurückgegeben. Bei einem Fehler wird der "**(% class="error" %)403 - Verboten: Zugriff verweigert.(%%)**" HTTP-Header gesendet..
16 == CSV Format ==
17 Bei einer korrekten Anfrage werden die Berichtsdaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
18 Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Danach folgen die Daten.
19 === Metainformationen ===
20 |=Trennzeichen|Semikolon ( ; )
21 |=Textbegrenzer|Doppeltes Hochkomma ( " )
22 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
23 |=Header|Zeile 1
24 |=Kodierung|UTF-8
25
26 === Spalten ===
27 |=Spalte|=Beschreibung
28 |NAME|Name des Workflows
29 |DESCRIPTION|ausführliche Beschreibung des Workflows
30
31 === JSON Format ===
32 **Rückgabe JSON**
33 {{code language="java"}}[
34 {
35 "name":"Spezial Reinigung",
36 "description":"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."
37 }
38 ]{{/code}}
39
40 === Beispielaufruf ===
41 **Beispielaufruf in CSV Format**
42 {{code language="java"}}https://map.yellowfox.de/rti/get_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
43
44 === Beispielantwort ===
45 **Beispielaufruf in CSV Format**
46 {{code language="java"}}"NAME";"DESCRIPTION"
47 "Spezial Reinigung";"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."{{/code}}
48