BPAPI Methods

BPAPI method Gateway

Gateway

Returns information about the Gateway identified by {id}

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Gateway  Details 

Syntax: Gateway/{id}/  Details 

Returns information about the Gateway 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)

{id} may be any of the following types:
gateway_id,
All (literally, like "Gateway/All"),
user_defined_name,
user_defined_group_name,
A quasi-SQL expression like "WHERE virtual_mode = 1" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered)
You may also search for multiple {id} values by separating each with comma. The different values may be of different types.




Unit-tests: 2 test(s)

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

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