Function: event.Complete

Completes an Event.

Syntax

{
	"method": "event.Complete",
	"params": {
		"id": "...",
		"forceComplete": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Complete( AdvGuid id, bool forceComplete );
public Task<bool> CompleteAsync(Guid id, bool forceComplete, CancellationToken ct = default);
complete(id: string, forceComplete: boolean): Promise<boolean>;

Parameters

id : guid

Id of the Event to complete.

forceComplete : bool

Result : bool

True if successful.

Errors

Data.NotFound ≥wg 0.4.4

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

Data.Forbidden ≥wg 0.4.4

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

Event.Complete.IncompleteMandatoryEntries ≥wg 0.4.4

One or more mandatory entries in this Event are incomplete. Can only be returned if forceComplete is false.

Event.Complete.NotEnded ≥wg 0.4.4

This Event has not yet ended. Can only be returned if forceComplete is false.

Event.Complete.IsAGroupMember ≥wg 0.4.4

This Event is part of a group and can not be completed. Can only be returned if forceComplete is false.

Event.Complete.NotAccepted ≥wg 0.4.4

This Event is not yet accepted and the server does not allow modification of unaccepted Events. Can only be returned if forceComplete is false.

Event.Complete.StationHasNoControl ≥wg 0.4.4

The current station does not have control of this Event. Can only be returned if forceComplete is false.

Remarks

This method requires API control access.