Table of Contents

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.

Retranslator flags:

Value Description
0x00000001 base flag
0x00000002 custom properties
0x00000004 billing properties
0x00000020 GUID

General properties

Flag - 0x00000001 

{
	"nm":<text>,	/* name */
	"cls":<uint>,	/* superclass ID: "avl_retranslator" */
	"id":<long>	/* retranslator ID */
}

Custom properties

Flag - 0x00000002

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

{
	"prp":{		/* custom properties */
		<text>:<text>,	/* name: value */
		...
	},
	"pup":{		/* private and public properties */
		"retranslator_config":<text>	/* retranslator properties ({\"protocol\":<text>,\"server\":<text>,\"port\":<text>,\"debug\":<text>}) */
		<text>:<text>,	/* name: value */
		...
	}
}

Billing

Flag - 0x00000004 

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

GUID

Flag - 0x00000020 

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