> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/net/soap.md).

# SOAP

Returns a fluent SOAP client for making SOAP web service requests.

This BIF creates a new or retrieves an existing BoxSoapClient instance based on the provided WSDL URL. The client can be used to fluently invoke SOAP operations discovered from the WSDL. The client provides fluent methods for configuring connection settings like setTimeout(), setAuthentication(), and addHeader().

Example usage:

```
 // Create a SOAP client from WSDL
 ws = soap( "http://example.com/service.wsdl" )

 // Invoke a SOAP operation: methodName, passing arguments as an array
 result = ws.invoke( "methodName", [ arg1, arg2 ] )

 // With authentication and timeout configuration
 ws = soap( "http://example.com/service.wsdl" )
     .setTimeout( 60 )
     .setAuthentication( "user", "pass" )

 result = ws.invoke( "methodName", [ arg1, arg2 ] )
 
```

## Method Signature

```
SOAP(URL=[string])
```

### Arguments

| Argument | Type     | Required | Description                                             | Default |
| -------- | -------- | -------- | ------------------------------------------------------- | ------- |
| `URL`    | `string` | `true`   | The URL to the WSDL document describing the web service |         |

## Examples

### Make a SOAP web service call

```java
// result = soap( url: "http://example.com/service.asmx", method: "GetData" );
writeOutput( "soap call" );

```

Result: soap call

## Related

* [GetLocalhostIp](/boxlang-language/reference/built-in-functions/net/getlocalhostip.md)
* [HTTP](/boxlang-language/reference/built-in-functions/net/http.md)


---

# 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://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/net/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.
