Search:

OBJECT

Plugin

Represents a SchoolPay plugin, modular code attached to a Company or Item that can respond to specific events in the SchoolPay system.

link GraphQL Schema definition

  • type Plugin {
  • Name: String
  • # If an operation on the Plugin is invoked, and an error occurs, a message
  • # describing the error will be populated on this field.
  • ErrorMessage: String
  • IsItemProviderCapable: Boolean
  • IsBalanceProviderCapable: Boolean
  • ProviderImage: String
  • ServiceName: String
  • # If the plugin is an ItemProvider plugin, querying this field will trigger a
  • # download of items from an external system, which will then be returned as
  • # TransientItems.
  • #
  • # Arguments
  • # DisableCache: [Not documented]
  • # StudentID: [Not documented]
  • ItemProviderItems(DisableCache: Boolean, StudentID: ID): [TransientItem]
  • # If the plugin is a StudentProvider or FoodServiceProvider, querying this field
  • # will trigger a student/balance update and return the resulting objects.
  • #
  • # Arguments
  • # DisableCache: [Not documented]
  • # StudentID: [Not documented]
  • StudentProviderStudents(
  • DisableCache: Boolean,
  • StudentID: ID
  • ): [Student]
  • }

link Require by

Go Live