BPAPI Methods

BPAPI method Gateway/Refresh

Gateway/Refresh

Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Gateway/Refresh  Details 

Syntax: Gateway/{id}/Refresh/  Details 

Syntax: Gateway/{id}/Refresh/{quick}/  Details 

Updates the BPAPI database with current device-information from the Gateway identified by {id} (fetches updated data from gateway)

The parameter {id} is optional. If not given the call will refresh 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)

The optional parameter {quick} may be set to TRUE or COMMON in order to refresh only properties most commonly needed to be updated on the server.
The optional parameter {quick} may be set to UNCOMMON in order to refresh properties NOT commonly needed to be updated on the server.
The optional parameter {quick} may be set to ALL or left empty in order to refresh ALL properties updated on the server.
For Sikom gateways this typically entails sending only ordinary S-requests for known devices.
For 'gateways' representing product presentation (internal use) {quick} may be set to a specific language like 'nb-NO', eventually with |quick added

Note that already known devices are not refreshed. You will have to use Device/Refresh for each known device individually if you want a total update.
In principle the database should automatically always be updated through the BPAPI Listener mechanism. Use this method if there are indications that the database has not been properly updated



See also Device/Refresh which is used for refreshing properties for individual devices.


Unit-tests: 3 test(s)

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

Documentation and tests automatically generated from source-code 2020-04-08 16:17