getNotesFromServiceTypeAndPlanTemplate static method
Future<PcoCollection<PcoServicesPlanNote> >
getNotesFromServiceTypeAndPlanTemplate(
- String serviceTypeId,
- String planTemplateId, {
- PcoServicesPlanNoteQuery? query,
- bool getAll = false,
- bool includePlanNoteCategory = false,
Will get a PcoCollection
of PcoServicesPlanNote objects (expecting one)
using a path like this: /services/v2/service_types/$serviceTypeId/plan_templates/$planTemplateId/notes
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<PcoServicesPlanNote>>
getNotesFromServiceTypeAndPlanTemplate(
String serviceTypeId,
String planTemplateId, {
PcoServicesPlanNoteQuery? query,
bool getAll = false,
bool includePlanNoteCategory = false,
}) async {
query ??= PcoServicesPlanNoteQuery();
if (getAll) query.getAll = true;
if (includePlanNoteCategory) query.include.add('plan_note_category');
var url =
'/services/v2/service_types/$serviceTypeId/plan_templates/$planTemplateId/notes';
return PcoCollection.fromApiCall<PcoServicesPlanNote>(url,
query: query, apiVersion: kApiVersion);
}