Wiki source code of get_persons.php
Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | (((Table of Contents))) | ||
3 | {{toc/}} | ||
4 | |||
5 | Returns the personal list. This is the personal name with it newest personal key. | ||
6 | = Description = | ||
7 | **(% class="green mark" %)GET(%%) get_persons.php****?company**=//COMPANY_RTIKEY//**&import**=//IMPORT_RTIKEY// | ||
8 | = Parameters = | ||
9 | |=Parameter|=Description|=Type|=Note|=Mandatory | ||
10 | |company|RTI company key|string||yes | ||
11 | |import|RTI import key for all vehicles/persons|string||yes | ||
12 | |||
13 | = Return = | ||
14 | A string is returned. On error the "**(% class="error" %)403 - Forbidden: Access Denied (%%)**" HTTP-Header is send. | ||
15 | == CSV format == | ||
16 | If the request is valid, the personal data are returned as CSV (Comma Separated Value) format. The first response line is always | ||
17 | the header, defining the column names. After it the personal data follows. | ||
18 | === Meta informations === | ||
19 | |=Separator|semicolon ( ; ) | ||
20 | |=Delimiter|double quote ( " ) | ||
21 | |=Line break|0x0D 0x0A (CarriageReturn LineFeed) | ||
22 | |=Header|line 1 | ||
23 | |=Encoding|UTF-8 | ||
24 | |||
25 | === Columns === | ||
26 | |=Column|=Description | ||
27 | |NAME|the person name | ||
28 | |KEY|latest personal key | ||
29 | |EMPL_NR|employee number | ||
30 | |||
31 | = Example Calls = | ||
32 | **example call** | ||
33 | {{code language="java"}}https://map.yellowfox.de/rti/get_persons.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}} | ||
34 | |||
35 | **example response** | ||
36 | {{code language="java"}}"NAME";"KEY";"EMPL_NR" | ||
37 | "Mr. Miller";"SP12345";"" | ||
38 | "Mrs. Meier";"SP48234";"1234"{{/code}} | ||
39 |