Function: location.Create

Creates the Location in the system and returns the id of the Location. The Location must not have an id. If an id is set, the creation is rejected and an empty id is returned.

Syntax

{
	"method": "location.Create",
	"params": {
		"object": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<AdvGuid> Create( Location object );
public Task<Guid> CreateAsync(Location @object, CancellationToken ct = default);
create(object: Location): Promise<string>;

Parameters

object : Location

The Location to create.

Result : guid

Id of the newly created category.

Remarks

This method requires API write access.

Validation

  • Id must not be set
  • Name must be a non-empty string that is unique within the location hierarchy
  • Order must be a non-empty, valid sorting string, i.e. consist of all upper-case letters and not end with ‘A’
  • The segment id must match the parent location’s (if a parent exists and has a segment id) and be available at the station