Go to appAcademyWhat's new?
Back
Artisan SVG > SOAP Client (soap-client) (globe-2)
SOAP Client
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Describe client
Copy

Description of services, ports and methods as a JavaScript object. Invokes the Client.describe() method of the 'soap' npm package.

Sample Input

1
{
2
    "wsdl": {
3
        "full_url": "https://api.example.com/services/ExampleService?wsdl"
4
    }
5
}

Sample Output

1
{
2
    "description": {
3
        "ExampleService": {
4
            "ExamplePort": {
5
                "getCustomerInfo": {
6
                    "input": {
7
                        "customerId": "xsd:string"
8
                    },
9
                    "output": {
10
                        "customerName": "xsd:string",
11
                        "customerEmail": "xsd:string",
12
                        "customerPhone": "xsd:string"
13
                    }
14
                },
15
                "updateCustomerInfo": {
16
                    "input": {
17
                        "customerId": "xsd:string",
18
                        "customerName": "xsd:string",
19
                        "customerEmail": "xsd:string",
20
                        "customerPhone": "xsd:string"
21
                    },
22
                    "output": {
23
                        "success": "xsd:boolean"
24
                    }
25
                }
26
            }
27
        }
28
    }
29
}

List SOAP methods
Copy

List the SOAP methods defined in a WSDL.

Sample Input

1
{
2
    "wsdl": {
3
        "full_url": "https://api.example.com/services/soap?wsdl"
4
    }
5
}

Sample Output

1
{
2
    "methods": [
3
        "createCustomer",
4
        "updateCustomer",
5
        "deleteCustomer",
6
        "getCustomerDetails",
7
        "listCustomers",
8
        "createOrder",
9
        "updateOrder",
10
        "cancelOrder",
11
        "getOrderStatus",
12
        "listOrders"
13
    ]
14
}

Send request
Copy

Send a request to a SOAP API to execute the selected SOAP web service method. Makes use of the 'soap' npm package.

Sample Input

1
{
2
    "wsdl": {
3
        "full_url": "https://api.example.com/WeatherService.wsdl"
4
    },
5
    "method": "GetWeatherForecast",
6
    "authentication": {
7
        "basic_auth_security_params": {
8
            "username": "user123",
9
            "password": "pass456"
10
        }
11
    },
12
    "xml_body": "<GetWeatherForecast><City>New York</City><Country>USA</Country></GetWeatherForecast>",
13
    "headers": "<CustomHeader><ApiKey>abc123def456</ApiKey></CustomHeader>",
14
    "endpoint": "https://api.example.com/WeatherService",
15
    "escape_xml": true
16
}

Sample Output

1
{
2
    "result": {
3
        "GetWeatherForecastResponse": {
4
            "Forecast": {
5
                "Date": "2023-05-15",
6
                "Temperature": {
7
                    "High": 25,
8
                    "Low": 18
9
                },
10
                "Conditions": "Partly Cloudy"
11
            }
12
        }
13
    },
14
    "responseHeaders": {
15
        "content-type": "application/soap+xml; charset=utf-8",
16
        "content-length": "423",
17
        "date": "Mon, 15 May 2023 12:34:56 GMT",
18
        "server": "Apache/2.4.41 (Unix)"
19
    },
20
    "statusCode": 200
21
}
Previous

Overview

Next

Operations