General information CB webservice
- Wilma Valkis - Temminck
General webservice information
Content-Type
The content/body in the request and the response has to be / will be in json format.
| Content-Type | application/json |
Servers | |
|---|---|
| Production | https://services.cb.nl |
| Test | https://testservices.cb.nl |
Supported SSL/TLS protocols | |
|---|---|
| TLS Protocols | TLS1.2 |
| TLS1.3 | |
Authentication
CB uses message level authentication based on header parameters “UserName” and “Password”. These will be provided when you sign up for this service at CB.
Response messages
If a webservice is technical able to process, it will respond with a HTTP status 200. The response can contain a message with additional information. It can be an error (MessageType “E”) in case it wasn’t possible to supply a functional answer or additional explanation/information about the answer (MessageType “I”).
A message contains of:
| A message contains of: | |
|---|---|
| MessageType | E or I |
| MessageCode | format XXX-99999 |
| MessageText | Textual information/reason |
The following generic error (E) messages are defined: | |
|---|---|
| WMS-00002 | Invalid username/password combination |
| WMS-00004 | Not authorized to use this service |
| WMS-00005 | No username and/or password provided by the caller |
| EBS-11000 | Something went wrong in processing the request |
| EBS-11001 | Something went wrong in processing the request |
Optional parameter
For any optional attribute one of the following options applies:
- be filled with the correct value
- be left out
- be filled with “” (read empty)
An optional parameter may therefore never be filled with the value null.