Function: location.Update

Updates a Location with data from the provided Object.

Syntax

{
	"method": "location.Update",
	"params": {
		"object": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Update( Location object );
public Task<bool> UpdateAsync(Location @object, CancellationToken ct = default);
update(object: Location): Promise<boolean>;

Parameters

object : Location

Location to update

Result : bool

True if successful.

Remarks

This method requires API write access.

Validation

  • Id must be set and a location with that id must exist before calling this function
  • 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