Edit

Share via

SOAP Web Service URIs

  • Article

Web service users can discover published web services by pointing a browser or a tool such as the Web Services Discovery Tool at the computer running Business Central Server and getting a list of available services. For SOAP web services, you typically enter a URI in a browser to view a list of available Business Central web services or to view a schema for a particular web service.

Note

For on-premises environments where SOAP, OData, or APIs have been turned off, any call to such an endpoint will also return a HTTP status code 405 (so check your server configurations if you see those).

Note

Support for the SOAP protocol is being deprecated in Business Central and will be removed in the future. Start planning to move your solutions to use either OData or APIs pages/queries. The article Deprecated Features in the Platform - Clients, Server, and Database will include a section of which release this will happen in when a timeline is available for the removal.

URIs for SOAP Web Services (for on-premises)

To display all published SOAP web services that are exposed by a Business Central Server instance, use a URI of the following type:

https://<Server>:<Port>/<ServerInstance>/WS/<CompanyName>/services

The following example displays all published SOAP web services that are exposed for the CRONUS International Ltd. demonstration database.

https://localhost:7047/BC130/WS/CRONUS%20International%20Ltd/services

To view the schema for a particular service, use a URI of the following type:

https://<Server>:<Port>/<ServerInstance>/WS/<CompanyName>/Page/<servicename>

The following example displays the schema for the Customer service for the CRONUS International Ltd. demonstration database.

https://localhost:7047/BC130/WS/CRONUS%20International%20Ltd/Page/Customer

You can also use a URI for a codeunit web service, as shown in the following example:

https://localhost:7047/BC130/WS/CRONUS%20International%20Ltd/Codeunit/Letters

See Also

Web service performance
Troubleshoot web service errors
Web service telemetry
SOAP Web Services