getAllPromotesToSchoolFromSchoolOption static method

Future<PcoCollection<PcoPeopleSchoolOption>> getAllPromotesToSchoolFromSchoolOption(
  1. String schoolOptionId, {
  2. String? id,
  3. PcoPeopleSchoolOptionQuery? query,
})

Will get a PcoCollection containing ALL PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/school_options/$schoolOptionId/promotes_to_school

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.

This function forces the query.getAll to be true.

Implementation

static Future<PcoCollection<PcoPeopleSchoolOption>>
    getAllPromotesToSchoolFromSchoolOption(
  String schoolOptionId, {
  String? id,
  PcoPeopleSchoolOptionQuery? query,
}) async {
  query ??= PcoPeopleSchoolOptionQuery();
  query.getAll = true;

  var url = '/people/v2/school_options/$schoolOptionId/promotes_to_school';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleSchoolOption>(url,
      query: query, apiVersion: kApiVersion);
}