Integration Solutions
Getting started
General information
The URL to where the web service itself can be accessed follows the following standard:
http://www.bisgateway.com/brg/services/<service_name>/
- Customer code
- Customer code owner
- User id
- User Password
The login account consists of three parameters:
- Customer code
- User
- Password
SOAP
All communication with the Bisgateway takes place using the Simple Object Access Protocol (SOAP) as protocol/message format. This means that all of the Bisgateway web services should be accessed with SOAP requests via HTTP. Each service’ interface is described in detail in a Web Service Definition Language (WSDL) file.
A raw SOAP request message to the gateway might look something like this
The corresponding SOAP response message looks like this
Please see each service’ section below for a SOAP example request to each service.
All services require that you set a SOAP action as a HTTP header. This is for the Bisgateway to be able to route the message to the correct service. In you don’t specify a SOAP action then the gateway won’t be able to handle the request.
SOAP Headers
Several of the Bisgateway web services uses SOAP headers to communicate for example login account information. The SOAP headers are placed in the Header section of the message
The SOAP response message could also contain headers, for example the timeTaken header
SOAP headers which are not specified in the WSDL file, except in the schema part, are called optional headers. They can be sent in a request but they are not mandatory. If you generate proxy code from the WSDL file, specific code for these headers will not be included. If you want to send them, you have to specify them yourself. Please refer to the FAQ Java section for an example on how to do this in Java.
Error handling
A SOAP fault example, as it will look when returned from the Bisgateway
The following table shows the specific errors that the Bisgateway can return:
| ErrorCode | Exception | Description |
|---|---|---|
| 100 | LoggableXmlMessageException
|
General error (none of the below) |
| 101 | AuthenticationException | Incorrect login |
| 102 | AuthorizationException | The service requested is not allowed for specified the user |
| 103 | BackendCommunicationFailureException | An error has occured in the communication with the Bisgateway and the back end system (e.g. NRG) |
| 104 | BackendFailureException | An error has occured in the backend system |
| 105 | InvalidInputException | Incorrect input, e.g a mandatory header, such as language, from Country or to Country is missing |
The following codes are not errors per se, but they are also returned as SOAP faults.
The following codes are not errors per se, but they are also returned as SOAP faults.
| ErrorCode | Exception | Description |
|---|---|---|
| 200 | NoHitsException | No hits in the back end database |
| 201 | TooManyHitsException | Too many hits in the back end database |
Namespaces
Here follows an overview of all namespaces used in the Bisgateway web services. The namespaces are ordinary xml namespaces, used to distinguish the xml elements in the SOAP headers and body from one another.
http://www.dnbnordic.com/brg/<service_name>/request
http://www.dnbnordic.com/brg/<service_name>/response
http://www.dnbnordic.com/brg
The log namespace is used for logging information:
http://www.dnbnordic.com/brg/log
http://www.dnbnordic.com/brg/faults



