X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FMethods%2FGetAddresses.py;h=24d5aa28d9642c4bb3260cb7bda845312336cf2f;hb=2fe12af6440fcc9fba6c086c8db883b4fcb20583;hp=75b8ad655c983e6fb83a570cda29865bee579af7;hpb=1f8c38dd1357c93e4be8d94456b7274a591d2db4;p=plcapi.git diff --git a/PLC/Methods/GetAddresses.py b/PLC/Methods/GetAddresses.py index 75b8ad6..24d5aa2 100644 --- a/PLC/Methods/GetAddresses.py +++ b/PLC/Methods/GetAddresses.py @@ -1,24 +1,30 @@ from PLC.Faults import * from PLC.Method import Method from PLC.Parameter import Parameter, Mixed +from PLC.Filter import Filter from PLC.Addresses import Address, Addresses from PLC.Auth import Auth class GetAddresses(Method): """ - Get an array of structs containing details about addresses. If - address_id_list is specified, only the specified addresses will be - queried. + Returns an array of structs containing details about addresses. If + address_filter is specified and is an array of address + identifiers, or a struct of address attributes, only addresses + matching the filter will be returned. If return_fields is + specified, only the specified details will be returned. """ roles = ['admin', 'pi', 'user', 'tech'] accepts = [ Auth(), - [Address.fields['address_id']], + Mixed([Address.fields['address_id']], + Filter(Address.fields)), + Parameter([str], "List of fields to return", nullok = True) ] returns = [Address.fields] + - def call(self, auth, address_id_list = None): - return Addresses(self.api, address_id_list).values() + def call(self, auth, address_filter = None, return_fields = None): + return Addresses(self.api, address_filter, return_fields)