Function: event.Fetch

Fetches an Event and assigns the current Station to it.

Syntax

{
	"method": "event.Fetch",
	"params": {
		"id": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<void> Fetch( AdvGuid id );
public Task FetchAsync(Guid id, CancellationToken ct = default);
fetch(id: string): Promise<>;

Parameters

id : guid

Id of the Event to fetch.

Result : void

Errors

Data.Forbidden

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

Data.NotFound

The requested data was not found or the caller does not have the required permission to access it. For additional information, see Data.NotFound.

Precondition.Failed

Specific required conditions were not satisfied before processing. Details can be found in the error message. For additional information, see Precondition.Failed.

Remarks

This method requires API control access.

Preconditions

  • Visibility (only unarchived Events)
  • The API client must not be associated with an anonymous Station.
  • If “exclusive operation” is enabled, the Event can only be controlled by the current controlling Station.
  • The Event must not be completed.
  • The Event must not be a group member.
  • The caller’s Station must either be without Segments or contain the Event’s Segment.
  • event.fetch right

Visibility

  • An unarchived Event isn’t visible to the caller if it is assigned to a different Station and the Event’s NotifiedStations property doesn’t contain the caller’s Station. The right “See events of other stations” circumvents this check.
  • An Event isn’t visible to the caller if it belongs to a foreign Segment.
  • An Event isn’t visible to the caller if the Event view rights don’t permit it.
  • An Event isn’t visible to the caller if the Event’s Datapoint view rights don’t permit it.
  • An Event isn’t visible to the caller if the Event’s Location view rights don’t permit it.