Retranslators
Depending on the specified flags, the response format may vary.
This chapter describes the flags that can be applied to retranslators and the corresponding parts of the resulting JSON they control. If multiple flags are specified, their respective parts are combined into a single JSON.
Specify flags in DEC format, as described in Data format.
The contents of the response also depend on your access rights to the item. For details, see Flags and access rights.
Retranslator flags
The following flags can be applied to retranslators:
| HEX value | DEC value | Description |
|---|---|---|
| 0x00000001 | 1 | Base flag |
| 0x00000002 | 2 | Custom properties |
| 0x00000004 | 4 | Billing information |
| 0x00000040 | 64 | GUID |
| 0x00000100 | 256 | State and configuration |
| 0x00000200 | 512 | Retranslator units |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Set all possible retranslator flags |
General properties
The flag of general properties is 0x00000001 (1).
{
"nm":<text>, // Name
"cls":<uint>, // Superclass ID of avl_retranslator (see the classes key in the token/login response)
"id":<long>, // Retranslator ID
"mu":<uint>, // Measurement system:
// 0 — SI,
// 1 — US,
// 2 — imperial,
// 3 — metric with gallons
"uacl":<long> // User's access rights to the retranslator (64-bit value)
}
Custom properties
The flag of custom properties is 0x00000002 (2).
You can store any retranslator data in custom properties.
{
"prp": {}, // Custom properties
"ftp": { // FTP settings
"hs": <text>, // Host (only if set)
"lg": <text>, // Login (only if set)
"pt": <text>, // Directory path (only if set)
"ch": <uint>, // FTP settings validity: 1 — yes, 0 — no
"tp": <uint>, // Use Wialon hosting FTP: 1 — yes, 0 — no
"fl": <uint> // Wialon hosting FTP availability: 1 — yes, 0 — no
},
"ct": <uint> // Creation time (Unix timestamp)
}
Billing information
The flag of billing information is 0x00000004 (4).
{
"crt": <uint>, // Creator ID
"bact": <uint> // Account ID
}
GUID
The flag of GUID is 0x00000040 (64).
{
"gd": <text> // Retranslator GUID
}
State and configuration
The flag of state and configuration is 0x00000100 (256).
{
"rtro": <int>, // State: 0 — disabled, 1 — enabled
"rtrst": <uint>, // Time when the retranslation stops automatically (Unix timestamp), 0 if the time isn't set
"rtrc": { // Configuration. The set of fields depends on the protocol
"protocol": <text>, // Protocol
"server": <text>, // Server for retransmission
"port": <ushort>, // Port (for all protocols except NIS, SOAP, and RTTI). Returned in the type it was saved with, so it can also be a string
"auth": <text>, // Authorization (only for NIS, Wialon IPS, TRN, and RTTI)
"ssl": <int>, // Secure connection (only for NIS): 1 — yes, 0 — no
"v6type": <int>, // Use protocol version 6 (only for Granit Navigator): 1 — yes, 0 — no
"attach_sensors": <int>, // Retranslate calculated sensor values (only for Wialon Retranslator and Wialon IPS): 1 — yes, 0 — no
"scoutOpen": <int>, // Use the Skaut Open variant of the protocol (only for Skaut): 1 — yes, 0 — no
"notauth": <int>, // Disable authorization (only for EGTS): 1 — yes, 0 — no
"timeoutauth": <int>, // Time in seconds after which the authorization repeats (only for EGTS). If the value is 0, the connection is authorized once
"didauth": <int>, // Use the device ID for authorization (only for EGTS): 1 — yes, 0 — no
"fuel": <int>, // Retranslate the values of fuel level sensors (only for EGTS): 1 — yes, 0 — no
"binauth": <int>, // Send the authorization code in binary form (only for TRN): 1 — yes, 0 — no
"carrier": <uint>, // Carrier ID (only for RTTI)
"login": <text>, // Login (only for SOAP)
"password": <text>, // Password (only for SOAP)
"debug": <int> // Debug mode: 1 — yes, 0 — no (only if set)
}
}
Protocol types are described on the update_config page.
Retranslator units
The flag of retranslator units is 0x00000200 (512).
{
"rtru": [{ // List of units
"i": <long>, // Unit ID
"a": <text>, // Unit identifier (alias) under which the unit is retranslated to the receiving server. It can differ from the unit ID
"st": <uint> // Time when the unit is automatically removed from the retranslator (Unix timestamp), 0 if the time isn't set
}]
}