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.Addresses import Address, Addresses
   5 from PLC.Auth import PasswordAuth
   6
   7 class GetAddresses(Method):
   8     """
   9     Get an array of structs containing details about addresses. If
  10     address_id_list is specified, only the specified addresses will be
  11     queried.
  12     """
  13
  14     roles = ['admin', 'pi', 'user', 'tech']
  15
  16     accepts = [
  17         PasswordAuth(),
  18         [Address.fields['address_id']],
  19         ]
  20
  21     returns = [Address.fields]
  22
  23     def call(self, auth, address_id_list = None):
  24         addresses = Addresses(self.api, address_id_list).values()
  25
  26         # Turn each address into a real dict
  27         addresses = [dict(address) for address in addresses]
  28
  29         return addresses