Function: event.RemoveNote

Removes a note attachment from an Event.

Syntax

{
	"method": "event.RemoveNote",
	"params": {
		"id": "...",
		"attachmentId": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> RemoveNote( AdvGuid id, int attachmentId );
public Task<bool> RemoveNoteAsync(Guid id, long attachmentId, CancellationToken ct = default);
removeNote(id: string, attachmentId: number): Promise<boolean>;

Parameters

id : guid

Id of the Event to remove the note attachment from.

attachmentId : int

Id of the attachment to remove. This has to be a note attachment or this function will fail.

Result : bool

True if successful.

Errors

Data.NotFound ≥wg 0.4.9

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.9

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

Event.RemoveNote.NoAttachmentLicense ≥wg 0.4.9

The product is not licensed for attachment handling.

Event.RemoveNote.EventIsCompleted ≥wg 0.4.9

Events that are already completed cannot have their attachments removed.

Event.RemoveNote.StationHasNoControl ≥wg 0.4.9

Attachments can only be removed if the station is allowed to modify the event.

Event.RemoveNote.NotAccepted ≥wg 0.4.9

Attachments can only be removed if the event was accepted or this prerequisite is disabled in the settings.

Event.RemoveNote.InvalidAttachmentType ≥wg 0.4.9

Attachment is not a note.

Remarks

This method requires API write access.