Wiki source code of get_tour_workflows.php

Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
1 (% class="box" %)
2 (((Table of Contents)))
3 {{toc/}}
4
5 Returns the list of all public available workflows for tour elements of a company.
6 = Description =
7 **(% class="green mark" %)GET(%%) get_tour_workflows.php****?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY//
8 = Parameter =
9 |=parameter|=description|=type|=hint|=mandatory
10 |company|RTI company key|string||yes
11 |import|RTI import key|string||yes
12 |format|response format|string|'csv' or'json'. Default is 'csv'.|no
13
14 = Return =
15 A character string is returned. On error "**(% class="error" %)403 - forbidden: access denied.(%%)**" http-header will be sent.
16 == CSV format ==
17 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.
18 === Meta information ===
19 |=separator|semicolon ( ; )
20 |=text delimiter|double quotes ( " )
21 |=line end|0x0D 0x0A (CarriageReturn LineFeed)
22 |=header|line 1
23 |=encoding|UTF-8
24
25 === Columns ===
26 |=column|=description
27 |NAME|name of workflow
28 |DESCRIPTION|verbose description of this workflow
29
30 === JSON format ===
31 **return json**
32 {{code language="java"}}[
33 {
34 "name":"Spezial Reinigung",
35 "description":"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."
36 }
37 ]{{/code}}
38
39 === Example call ===
40 **return in csv**
41 {{code language="java"}}https://map.yellowfox.de/rti/get_tour_workflows.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
42
43 === Example response ===
44 **return in csv**
45 {{code language="java"}}"NAME";"DESCRIPTION"
46 "Spezial Reinigung";"Das ist mein Freies Notizfeld, wo ich mir Anmerkungen zum Workflow schreiben kann."{{/code}}
47