BPAPI Methods

BPAPI method Gateway/Property

Gateway/Property

Returns property {name} for Gateway or Location identified by {id}

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Gateway/{id}/Property/{name}/  Details   Details 

Syntax: Gateway/{id}/Property/{name}/{field}/  Details   Details 

Returns property {name} for Gateway or Location identified by {id}
The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used. (in this case the call will fail if more than one gateway has been assigned). See Gateway for more information about specifying {id}

Optionally a sub-field of property may be specified as the {field} parameter. This is useful if just some specific information is needed.

{name} may consist of multiple property names separated by comma


See also Device/Property which shows more query options.


Unit-tests: 4 test(s)

Popularity: 202 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-04-07 11:17