create_retranslator

The create_retranslator function is used to create a new retranslator.

Copied!
svc=core/create_retranslator&params={"creatorId":<long>,
				     "name":"<text>",
				     "config":{		
						"protocol":"<text>",	
						"server":"<text>",
						"port":<ushort>,
						"auth":"<text>",
						"ssl":<int>,
						"debug":<int>,
						"v6type":<int>
				      },			     
				      "dataFlags":<uint>}

Parameters

NameDescription

creatorId

The ID of the user that should be the creator of the retranslator. 

name

The name of the retranslator (4–50 characters).

config

Retranslator configuration.

protocol

Protocol ID (see the update_config page).

server

Retranslation server.

port

Port (for all protocols, except NIS).

auth

Authorization (only for NIS and Wialon IPS protocols).

ssl

Using SSL (for NIS):

  • no;
  • yes.

debug

Using the debug mode: 

  • no;
  • yes.

v6type

Using the protocol ver. 6 (only for Granit Navigator): 

  • no;
  • yes.

dataFlags

Flags with the retranslator properties for the returned result (see the retranslator page).

Returned result

Copied!
{
	"item":{	/* retranslator created */
		...	
	},
	"flags":<uint>	/* applied flags with properties */
}

The format of the item parameter is described on the retranslator page.

Possible error codes:

CodeDescription
6Failed to fetch the creator or failed to create retranslator.  
4

One of the following errors:

  • wrong input parameters;
  • failed to validate the configuration;
  • failed to create retranslator with the specified protocol (see the reason field for details).
Download PDF file
Download Word document

See also