get static method

Future<PcoCollection<PcoPeoplePerson>> get({
  1. String? id,
  2. PcoPeoplePersonQuery? query,
  3. bool getAll = false,
  4. bool includeAllRelated = false,
  5. bool includeAddresses = false,
  6. bool includeEmails = false,
  7. bool includeFieldData = false,
  8. bool includeHouseholds = false,
  9. bool includeInactiveReason = false,
  10. bool includeMaritalStatus = false,
  11. bool includeNamePrefix = false,
  12. bool includeNameSuffix = false,
  13. bool includeOrganization = false,
  14. bool includePersonApps = false,
  15. bool includePhoneNumbers = false,
  16. bool includePlatformNotifications = false,
  17. bool includePrimaryCampus = false,
  18. bool includeSchool = false,
  19. bool includeSocialProfiles = false,
})

Will get a PcoCollection of PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/people

Available Query Filters:

  • admins

  • created_since filter people created in the last 24 hours; pass an additional time parameter in ISO 8601 format to specify your own timeframe

  • organization_admins

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<PcoPeoplePerson>> get({
  String? id,
  PcoPeoplePersonQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeAddresses = false,
  bool includeEmails = false,
  bool includeFieldData = false,
  bool includeHouseholds = false,
  bool includeInactiveReason = false,
  bool includeMaritalStatus = false,
  bool includeNamePrefix = false,
  bool includeNameSuffix = false,
  bool includeOrganization = false,
  bool includePersonApps = false,
  bool includePhoneNumbers = false,
  bool includePlatformNotifications = false,
  bool includePrimaryCampus = false,
  bool includeSchool = false,
  bool includeSocialProfiles = false,
}) async {
  query ??= PcoPeoplePersonQuery();
  if (getAll) query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoPeoplePerson.canInclude);
  if (includeAddresses) query.include.add('addresses');
  if (includeEmails) query.include.add('emails');
  if (includeFieldData) query.include.add('field_data');
  if (includeHouseholds) query.include.add('households');
  if (includeInactiveReason) query.include.add('inactive_reason');
  if (includeMaritalStatus) query.include.add('marital_status');
  if (includeNamePrefix) query.include.add('name_prefix');
  if (includeNameSuffix) query.include.add('name_suffix');
  if (includeOrganization) query.include.add('organization');
  if (includePersonApps) query.include.add('person_apps');
  if (includePhoneNumbers) query.include.add('phone_numbers');
  if (includePlatformNotifications)
    query.include.add('platform_notifications');
  if (includePrimaryCampus) query.include.add('primary_campus');
  if (includeSchool) query.include.add('school');
  if (includeSocialProfiles) query.include.add('social_profiles');
  var url = '/people/v2/people';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeoplePerson>(url,
      query: query, apiVersion: kApiVersion);
}