create_route

The create_route function is used to create new routes.

Copied!
svc=core/create_route&params={"creatorId":<long>,
			      "name":"<text>",
			      "dataFlags":<uint>}

Parameters

NameDescription

creatorId

The ID of the user that should be the creator of the new route.

name

Route name (4–50 characters). 

dataFlags

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

Returned result

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

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

Possible error codes:

CodeDescription

7

Route library not loaded.

6

One of the following errors:

  • failed to fetch the route creator;
  • failed to create the route;
  • failed to check the access rights of the current user to the route

4

Wrong input parameters.

Download PDF file
Download Word document

See also