Retranslators

Depending on set flags format of response can differ.

This chapter describes flags that can be applied to retranslators and parts of resulting JSON which they are responsible for. If you specify several flags, then parts will be gathered into one JSON.

:!: All flags are only used in DEC format.

Retranslator flags:

Value HEX Value DEC Description
0x00000001 1 base flag
0x00000002 2 custom properties
0x00000004 4 billing properties
0x00000040 64 GUID
0x00000080 128 administrative fields
0x00000100 256 state and configuration
0x00000200 512 units
0x3FFFFFFFFFFFFFFF 4611686018427387903 set all possible flags to retranslator

General properties

Flag - 0x00000001

{
	"nm":<text>,	/* name */
	"cls":<uint>,	/* superclass ID: "avl_retranslator" */
	"id":<long>,	/* retranslator ID */
	"uacl":<uint>	/* current user access level for retranslator */
}

Custom properties

Flag - 0x00000002

You can store any retranslator data you need in custom properties.

{
	"prp":{}	/* custom properties */
}

Billing

Flag - 0x00000004

{
	"crt":<uint>,	/* creator ID */
	"bact":<uint>	/* account ID */
}

GUID

Flag - 0x00000040

{
	"gd":<text>	/* retranslator GUID */
}

Administrative fields

Flag - 0x00000080

{
	"aflds":{	/* administrative fields */		
		<text>:{	/* sequence number */
			"id":<uint>,	/* ID */
			"n":<text>,	/* name */
			"v":<text>	/* value */
		},
		...
	},
	"afldsmax":<long>,	/* maximal count of administrative fields (-1 - unlimited) */
}

Configuration

Flag - 0x00000100

{
	"rtro":<int>,		/* state: 0 - disable, 1 - enable */	
	"rtrc":{		/* configuration */
		"protocol":<text>,	/* protocol */
		"server":<text>,	/* server for retranslation */
		"port":<ushort>,	/* port (for all except NIS) */
		"auth":<text>,		/* authorization (only for NIS and Wialon IPS) */
		"ssl":<int>,		/* secure connection (for NIS): 1 - yes, 0 - no */
		"v6type":<int>,		/* use protocol ver.6 (only for Granit Navigator): 0 - no, 1 - yes */
		"login":<text>,		/* login */
		"password":<text>,	/* password */
		"notauth":<int>,	/* disable autorization (only for EGTS): 0 - no, 1 - yes */
	}
}

Types of protocols are described in the chapter Retranslators: Update configuration.

Units

Flag - 0x00000200

{
	"rtru":[{		/* list of units */
		"i":<long>,		/* unit ID */
		"a":<text>		/* hardware ID */
	}]
}
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2019 Gurtam