sms_BizTalk


Click here for a complete list of operations.

VerifyOriginator

Checks that the email sender is a valid system user and that the host sender is allowed.

Parameters
IP AddressIP Address of the domain that the message originates from.
OriginatorThe email address of the originator that sent the message.

Returns
If the originator is valid then sms sender credentials are returned. Otherwise an error will be returned.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
IPAddress:
Originator:
Username:
Password:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /sms/sms_biztalk.asmx HTTP/1.1
Host: sms.kirklees.gov.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "kmc.sms.biztalk/VerifyOriginator"

<?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>
    <VerifyOriginator xmlns="kmc.sms.biztalk">
      <IPAddress>string</IPAddress>
      <Originator>string</Originator>
      <Username>string</Username>
      <Password>string</Password>
    </VerifyOriginator>
  </soap:Body>
</soap:Envelope>
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>
    <VerifyOriginatorResponse xmlns="kmc.sms.biztalk">
      <VerifyOriginatorResult>
        <Authorised>boolean</Authorised>
        <Username>string</Username>
        <Password>string</Password>
        <Exception>string</Exception>
        <MsgId>string</MsgId>
      </VerifyOriginatorResult>
    </VerifyOriginatorResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /sms/sms_biztalk.asmx HTTP/1.1
Host: sms.kirklees.gov.uk
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>
    <VerifyOriginator xmlns="kmc.sms.biztalk">
      <IPAddress>string</IPAddress>
      <Originator>string</Originator>
      <Username>string</Username>
      <Password>string</Password>
    </VerifyOriginator>
  </soap12:Body>
</soap12:Envelope>
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>
    <VerifyOriginatorResponse xmlns="kmc.sms.biztalk">
      <VerifyOriginatorResult>
        <Authorised>boolean</Authorised>
        <Username>string</Username>
        <Password>string</Password>
        <Exception>string</Exception>
        <MsgId>string</MsgId>
      </VerifyOriginatorResult>
    </VerifyOriginatorResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /sms/sms_biztalk.asmx/VerifyOriginator?IPAddress=string&Originator=string&Username=string&Password=string HTTP/1.1
Host: sms.kirklees.gov.uk

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

<?xml version="1.0" encoding="utf-8"?>
<ApplicationUser xmlns="kmc.sms.biztalk">
  <Authorised>boolean</Authorised>
  <Username>string</Username>
  <Password>string</Password>
  <Exception>string</Exception>
  <MsgId>string</MsgId>
</ApplicationUser>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /sms/sms_biztalk.asmx/VerifyOriginator HTTP/1.1
Host: sms.kirklees.gov.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

IPAddress=string&Originator=string&Username=string&Password=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ApplicationUser xmlns="kmc.sms.biztalk">
  <Authorised>boolean</Authorised>
  <Username>string</Username>
  <Password>string</Password>
  <Exception>string</Exception>
  <MsgId>string</MsgId>
</ApplicationUser>