getFromCheckIn static method

Future<PcoCollection<PcoCheckInsCheckInGroup>> getFromCheckIn(String checkInId, { String? id, PcoCheckInsCheckInGroupQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckIns = false, bool includeEventPeriod = false, bool includePrintStation = false, })

Will get a PcoCollection of PcoCheckInsCheckInGroup objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/check_in_group

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<PcoCheckInsCheckInGroup>> getFromCheckIn(
  String checkInId, {
  String? id,
  PcoCheckInsCheckInGroupQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeCheckIns = false,
  bool includeEventPeriod = false,
  bool includePrintStation = false,
}) async {
  query ??= PcoCheckInsCheckInGroupQuery();
  if (getAll) query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoCheckInsCheckInGroup.canInclude);
  if (includeCheckIns) query.include.add('check_ins');
  if (includeEventPeriod) query.include.add('event_period');
  if (includePrintStation) query.include.add('print_station');
  var url = '/check-ins/v2/check_ins/$checkInId/check_in_group';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoCheckInsCheckInGroup>(url,
      query: query, apiVersion: kApiVersion);
}