BWS API Docs
Ask or search…
K
Comment on page

API Responses

statusCode, statusMessage, info
When calling BWS API, you can get an HTTP layer transport error, that is, an error that has occurred before our code is executed (for example, 503 - Service Unavailable), or a controlled error, meaning an error that is related to the parameters' values you send (404 - not found, when no data is found for your query for example).
When no transport layer error is returned, you will get a JSON message including the following parameters in the BODY part of the response:
Parameter
Type
Description
statusCode
number
The api call result code (200 if there is no error).
statusMessage
string
The status code related message (optional).
info
object
The requested information.
API RESPONSE EXAMPLE
An API call response indicating the job id you can use to fetch results.
{
"statusCode": 200,
"info": {
"jobId": "543433243"
}
}