getSingleFromForm static method

Future<PcoPeopleFormSubmission?> getSingleFromForm(
  1. String formId,
  2. String id,
  3. {PcoPeopleFormSubmissionQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeForm = false,
  6. bool includeFormFields = false,
  7. bool includeFormSubmissionValues = false,
  8. bool includePerson = false}
)

Will get a single PcoPeopleFormSubmission object using a path like this: /people/v2/forms/$formId/form_submissions/[id]

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<PcoPeopleFormSubmission?> getSingleFromForm(
  String formId,
  String id, {
  PcoPeopleFormSubmissionQuery? query,
  bool includeAllRelated = false,
  bool includeForm = false,
  bool includeFormFields = false,
  bool includeFormSubmissionValues = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeopleFormSubmissionQuery();
  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/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleFormSubmission>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}