PLC/Methods/AddAddressTypeToAddress.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.AddressTypes import AddressType, AddressTypes
   5 from PLC.Addresses import Address, Addresses
   6 from PLC.Auth import Auth
   7
   8 class AddAddressTypeToAddress(Method):
   9     """
  10     Adds an address type to the specified address.
  11
  12     PIs may only update addresses of their own sites.
  13
  14     Returns 1 if successful, faults otherwise.
  15     """
  16
  17     roles = ['admin', 'pi']
  18
  19     accepts = [
  20         Auth(),
  21         Mixed(AddressType.fields['address_type_id'],
  22               AddressType.fields['name']),
  23         Address.fields['address_id']
  24         ]
  25
  26     returns = Parameter(int, '1 if successful')
  27
  28
  29     def call(self, auth, address_type_id_or_name, address_id):
  30         address_types = AddressTypes(self.api, [address_type_id_or_name])
  31         if not address_types:
  32             raise PLCInvalidArgument("No such address type")
  33         address_type = address_types[0]
  34
  35         addresses = Addresses(self.api, [address_id])
  36         if not addresses:
  37             raise PLCInvalidArgument("No such address")
  38         address = addresses[0]
  39
  40         if 'admin' not in self.caller['roles']:
  41             if address['site_id'] not in self.caller['site_ids']:
  42                 raise PLCPermissionDenied("Address must be associated with one of your sites")
  43
  44         address.add_address_type(address_type)
  45         self.event_objects = {'Address': [address['address_id']]}
  46
  47         return 1