getFromForm static method

Future<PcoCollection<PcoPeopleFormSubmission>> getFromForm(String formId, { String? id, PcoPeopleFormSubmissionQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeForm = false, bool includeFormFields = false, bool includeFormSubmissionValues = false, bool includePerson = false, })

Will get a PcoCollection of PcoPeopleFormSubmission objects (expecting many) using a path like this: /people/v2/forms/$formId/form_submissions

Getting a PcoCollection is useful even when retrieving a single object because it contains error data and helper functions.

Additional options may be specified by using the query argument, but some query options are also available as boolean flags in this function call too.

Implementation

static Future<PcoCollection<PcoPeopleFormSubmission>> getFromForm(
  String formId, {
  String? id,
  PcoPeopleFormSubmissionQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeForm = false,
  bool includeFormFields = false,
  bool includeFormSubmissionValues = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeopleFormSubmissionQuery();
  if (getAll) query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoPeopleFormSubmission.canInclude);
  if (includeForm) query.include.add('form');
  if (includeFormFields) query.include.add('form_fields');
  if (includeFormSubmissionValues)
    query.include.add('form_submission_values');
  if (includePerson) query.include.add('person');
  var url = '/people/v2/forms/$formId/form_submissions';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleFormSubmission>(url,
      query: query, apiVersion: kApiVersion);
}