Troubleshoot web services
Troubleshooting guides for Business Central web services (OData, API and SOAP). They answer questions about failed calls, HTTP status codes, OData error codes, how AL runtime exceptions map to OData errors, and which telemetry and debugging tools help find the cause.
Path: Development > Troubleshooting > Troubleshooting guides (TSGs) > Troubleshoot web services · tier official · system development · narrative reviewed (checked by Opus)
Overview
This section holds two troubleshooting guides for failed web service calls in Business Central. One is a general guide for OData, API and SOAP errors. The other focuses on REST API and OData calls.
The general guide helps you decide whether an error comes from the client, the network or the server endpoint. It points to HTTP status codes, web service telemetry, OData error codes, debugging tools, external service calls and comparing environments.
The REST API/OData guide goes deeper on error codes and maps AL runtime exceptions to the OData error messages they produce. Start with the general guide to locate the source of the failure. Then use the REST API/OData guide to interpret specific error responses.
Key points
- Two pages: a general guide for OData, API and SOAP errors, and one specific to REST API/OData calls.
- First step is to identify whether the error originates from the client, network or server endpoint.
- HTTP status codes and OData error codes are the main signals for diagnosing a failed call.
- Web service telemetry is a key tool for investigating failures.
- The REST API/OData page maps AL runtime exceptions to OData error messages.
- The AL debugger and other debugging tools can be used to investigate server-side problems.
- Comparing environments and checking external service calls are listed as troubleshooting approaches.
Learn pages
- Troubleshooting REST API/OData calls: Learn about how to troubleshoot Business Central web service errors of types REST API or OData.
- Troubleshooting web service errors (OData, API, and SOAP): Learn about how to troubleshoot Business Central web service errors (OData, API, and SOAP).
Source: Microsoft Learn (CC BY 4.0). Descriptions are Learn’s own.