Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎2017.2‎ > ‎

retrieve_buildings_by_partner

This method is almost identical to retrieve_buildings_by_id.  The only differences are in the permissions, and in the addition of the "partner" parameter.

This method exists to allow Partners to retrieve information about the building records that are created by their assessors.

Parameters

See retrieve_buildings_by_id - all parameters are identical except for the "partner" parameter, which is documented below.

NameDescriptionTypeRequired
 partner Name of the partner whose buildings should be retrieved.  If the calling user has the Partner role, this field may not be passed, as the results will automatically filtered on the user's partner.  If the calling user has the Admin role, this field is mandatory to allow filtering on a partner.stringMandatory. Partners must pass their own partner ID in this field. Admins may pass any partner ID.



Response

See retrieve_buildings_by_id



Roles

Method access is limited by the roles assigned the user to whom the session token was assigned

RoleAccess
AssessorNo access
PartnerAccess allowed
 Admin Access allowed