Table of Contents

Interface ISubmissionApi

Namespace
MegaForm.Sdk
Assembly
MegaForm.Sdk.dll

Query, submit, update and delete submissions.

public interface ISubmissionApi

Methods

DeleteAsync(int, MegaFormScope?, CancellationToken)

Permanently delete a submission. No-op if the submission is not in this portal.

Task DeleteAsync(int submissionId, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

submissionId int
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task

FindAsync(SubmissionQuery, MegaFormScope?, CancellationToken)

Find submissions for a form with optional status filter + paging (FindData).

Task<PagedResult<SubmissionDto>> FindAsync(SubmissionQuery query, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

query SubmissionQuery
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<PagedResult<SubmissionDto>>

GetAsync(int, MegaFormScope?, CancellationToken)

Get a single submission by id, or null if not found.

Task<SubmissionDto?> GetAsync(int submissionId, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

submissionId int
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<SubmissionDto>

SubmitAsync(int, Dictionary<string, object>, MegaFormScope?, CancellationToken)

Submit form data, running the same server-side validation as a public form submit. When the host registered the full submission pipeline (anti-spam, notifications, workflow), this delegates to it; otherwise it validates and inserts the row. On a validation failure the result's Success is false and no row is saved.

Task<SubmitResult> SubmitAsync(int formId, Dictionary<string, object> data, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

formId int
data Dictionary<string, object>
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task<SubmitResult>

UpdateAsync(int, Dictionary<string, object>, MegaFormScope?, CancellationToken)

Replace a submission's stored data (full replace, not merge). No-op if the submission is not in this portal.

Task UpdateAsync(int submissionId, Dictionary<string, object> data, MegaFormScope? scope = null, CancellationToken cancellationToken = default)

Parameters

submissionId int
data Dictionary<string, object>
scope MegaFormScope
cancellationToken CancellationToken

Returns

Task