PLC/Methods/GetAddresses.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Filter import Filter
   5 from PLC.Addresses import Address, Addresses
   6 from PLC.Auth import Auth
   7
   8 class GetAddresses(Method):
   9     """
  10     Returns an array of structs containing details about addresses. If
  11     address_filter is specified and is an array of address
  12     identifiers, or a struct of address attributes, only addresses
  13     matching the filter will be returned.
  14     """
  15
  16     roles = ['admin', 'pi', 'user', 'tech']
  17
  18     accepts = [
  19         Auth(),
  20         Mixed([Address.fields['address_id']],
  21               Filter(Address.fields))
  22         ]
  23
  24     returns = [Address.fields]
  25
  26     def call(self, auth, address_filter = None):
  27         return Addresses(self.api, address_filter).values()