> For the complete documentation index, see [llms.txt](https://developer.ultimo.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ultimo.net/api-guide/soap.md).

# SOAP

:no\_entry\_sign:Professional :white\_check\_mark:Premium :white\_check\_mark:Enterprise

This section explains how to setup a connection to the WCF / SOAP service.

## How to set up

To connect to the WCF / SOAP service, a connector has to be created for a client. Connectors can be defined in the Ultimo Configuration Tool. A connector contains a definition of entities and properties that are available in the SOAP body.

{% hint style="info" %}
Note: For more information on how to configure connectors please contact your Ultimo consultant. 
{% endhint %}

## How to connect

The url to send the request to:

`https://customer.ultimo.net/WebServices/SoapConnector.svc`

* `https://customer.ultimo.net/`

  is the domain name where the Ultimo software is available.
* `/WebServices/SoapConnector.svc`

  is a relative path, if the Ultimo software is installed in a different directory.

*Example:*

Ultimo Software is located at:\
`https://yourdomain.ultimo.net/`

Then the path should be:\
`https://yourdomain.ultimo.net/Webservices/SoapConnector.svc`

## WSDL

Available functionality within the SOAP web service can be found inside the WSDL description.

`https://customer.ultimo.net/WebServices/SoapConnector.svc?wsdl`

## Authentication

When sending a request to the SOAP web service, authentication should be added to the SOAP body.

## Limitation

When sending a request using SOAP, a maximum payload size of 20MB per request is accepted.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.ultimo.net/api-guide/soap.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.