Versions Compared

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
 get_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ü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."
	}
]

Beispielaufruf

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

Beispielantwort

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


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


Sv translation
languageen

Returns the list of all public available workflows for tour elements of a company.

Description

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

NAMEname of workflow
DESCRIPTIONverbose description of this workflow

JSON format

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

Example call

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

Example response

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