getPromotesToSchoolFromSchoolOption static method

Future<PcoCollection<PcoPeopleSchoolOption>> getPromotesToSchoolFromSchoolOption(
  1. String schoolOptionId, {
  2. String? id,
  3. PcoPeopleSchoolOptionQuery? query,
  4. bool getAll = false,
})

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

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<PcoPeopleSchoolOption>>
    getPromotesToSchoolFromSchoolOption(
  String schoolOptionId, {
  String? id,
  PcoPeopleSchoolOptionQuery? query,
  bool getAll = false,
}) async {
  query ??= PcoPeopleSchoolOptionQuery();
  if (getAll) 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);
}