LicenseKeyVariableLoad

This method retrieves the value of a variable. Variables can be used in your call scripts.

Syntax

LicenseKeyVariableLoad(VariableName, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
VariableName	The variable name. Values longer than 50 characters will be truncated.	String	True	country
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The value of the variable.

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

• C#
• Java
• Python
• GET Request
• POST Request
• SOAP 1.1 Request
• SOAP 1.1 Response
• SOAP 1.2 Request
• SOAP 1.2 Response
• XML Response

C#

/* https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Service Reference and given the name WSDL */

using WSDL;

var client = new PhoneNotifySoapClient(PhoneNotifySoapClient.EndpointConfiguration.PhoneNotifySoap);
var variableName = "country";
var variableValue = await client.LicenseKeyVariableLoadAsync(variableName, YOUR_LICENSE_KEY);

Console.WriteLine(variableValue);

Java

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

public final class LicenseKeyVariableLoad {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/LicenseKeyVariableLoad?"
                            + "VariableName=Variable1"
                            + "&LicenseKey=00000000-0000-0000-0000-000000000000");
            try {
                InputStream in = url.openStream();
                StreamSource source = new StreamSource(in);
                printResult(source);
            } catch (java.io.IOException e) {
                e.printStackTrace();
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    private static void printResult(Source source) {
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            StreamResult sr = new StreamResult(bos);
            Transformer trans = TransformerFactory.newInstance().newTransformer();
            Properties oprops = new Properties();
            oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperties(oprops);
            trans.transform(source, sr);
            System.out.println("**** Response ******");
            System.out.println(bos.toString());

            bos.close();
            System.out.println();
        } catch (Exception e) {
        }
    }
}

Python

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
variable_name = "country"
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.LicenseKeyVariableLoad(variable_name, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/LicenseKeyVariableLoad?VariableName=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

POST /NotifyWS/PhoneNotify.asmx/LicenseKeyVariableLoad HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

VariableName=string&LicenseKey=string

SOAP 1.1 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.esendex.us/NotifyWS/LicenseKeyVariableLoad"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LicenseKeyVariableLoad xmlns="https://ws.esendex.us/NotifyWS/">
      <VariableName>string</VariableName>
      <LicenseKey>string</LicenseKey>
    </LicenseKeyVariableLoad>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LicenseKeyVariableLoadResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LicenseKeyVariableLoadResult>string</LicenseKeyVariableLoadResult>
    </LicenseKeyVariableLoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LicenseKeyVariableLoad xmlns="https://ws.esendex.us/NotifyWS/">
      <VariableName>string</VariableName>
      <LicenseKey>string</LicenseKey>
    </LicenseKeyVariableLoad>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LicenseKeyVariableLoadResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LicenseKeyVariableLoadResult>string</LicenseKeyVariableLoadResult>
    </LicenseKeyVariableLoadResponse>
  </soap12:Body>
</soap12:Envelope>

XML Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="https://ws.esendex.us/NotifyWS/">string</string>