PLC/Methods/GetSites.py

   1 from PLC.Method import Method
   2 from PLC.Parameter import Parameter, Mixed
   3 from PLC.Filter import Filter
   4 from PLC.Auth import Auth
   5 from PLC.Sites import Site, Sites
   6
   7 class GetSites(Method):
   8     """
   9     Return an array of structs containing details about all sites. If
  10     site_id_list is specified, only the specified sites will be
  11     queried.
  12     """
  13
  14     roles = ['admin', 'pi', 'user', 'tech']
  15
  16     accepts = [
  17         Auth(),
  18         Mixed([Mixed(Site.fields['site_id'],
  19                      Site.fields['login_base'])],
  20               Filter(Site.fields))
  21         ]
  22
  23     returns = [Site.fields]
  24
  25     event_type = 'Get'
  26     object_type = 'Site'
  27     object_ids = []
  28
  29     def call(self, auth, site_filter = None):
  30         return Sites(self.api, site_filter).values()