getFromSongAndScheduledItemAndItemNote static method

Future<PcoCollection<PcoServicesItemNoteCategory>> getFromSongAndScheduledItemAndItemNote(
  1. String songId,
  2. String scheduledItemId,
  3. String itemNoteId, {
  4. PcoServicesItemNoteCategoryQuery? query,
  5. bool getAll = false,
})

Will get a PcoCollection of PcoServicesItemNoteCategory objects (expecting one) using a path like this: /services/v2/songs/$songId/last_scheduled_item/$scheduledItemId/item_notes/$itemNoteId/item_note_category

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<PcoServicesItemNoteCategory>>
    getFromSongAndScheduledItemAndItemNote(
  String songId,
  String scheduledItemId,
  String itemNoteId, {
  PcoServicesItemNoteCategoryQuery? query,
  bool getAll = false,
}) async {
  query ??= PcoServicesItemNoteCategoryQuery();
  if (getAll) query.getAll = true;

  var url =
      '/services/v2/songs/$songId/last_scheduled_item/$scheduledItemId/item_notes/$itemNoteId/item_note_category';

  return PcoCollection.fromApiCall<PcoServicesItemNoteCategory>(url,
      query: query, apiVersion: kApiVersion);
}