PLC/Methods/DeletePersonFromSite.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Persons import Person, Persons
   5 from PLC.Sites import Site, Sites
   6 from PLC.Auth import Auth
   7
   8 class DeletePersonFromSite(Method):
   9     """
  10     Removes the specified person from the specified site. If the
  11     person is not a member of the specified site, no error is
  12     returned.
  13
  14     Returns 1 if successful, faults otherwise.
  15     """
  16
  17     roles = ['admin']
  18
  19     accepts = [
  20         Auth(),
  21         Mixed(Person.fields['person_id'],
  22               Person.fields['email']),
  23         Mixed(Site.fields['site_id'],
  24               Site.fields['login_base'])
  25         ]
  26
  27     returns = Parameter(int, '1 if successful')
  28
  29
  30     def call(self, auth, person_id_or_email, site_id_or_login_base):
  31         # Get account information
  32         persons = Persons(self.api, [person_id_or_email])
  33         if not persons:
  34             raise PLCInvalidArgument, "No such account"
  35
  36         person = persons[0]
  37
  38         # Get site information
  39         sites = Sites(self.api, [site_id_or_login_base])
  40         if not sites:
  41             raise PLCInvalidArgument, "No such site"
  42
  43         site = sites[0]
  44
  45         if site['site_id'] in person['site_ids']:
  46             site.remove_person(person)
  47
  48         self.object_ids = [site['site_id']]
  49
  50         return 1