TextKeyServices


Click here for a complete list of operations.

issueTextKeyFromUserId

Issue TextKey using registered UserID and API Key

Test

The test form is only available for requests from the local machine.

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 /TPIServices/TextKey.asmx HTTP/1.1
Host: secure.textpower.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.textpower.com/services/issueTextKeyFromUserId"

<?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>
    <issueTextKeyFromUserId xmlns="http://www.textpower.com/services/">
      <userID>string</userID>
      <isHashed>boolean</isHashed>
    </issueTextKeyFromUserId>
  </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>
    <issueTextKeyFromUserIdResponse xmlns="http://www.textpower.com/services/">
      <issueTextKeyFromUserIdResult>
        <textKey>string</textKey>
        <status>boolean</status>
        <validationCode>string</validationCode>
        <mode>TextKeyOnly or PinCodeOnly or TextKeyPlusPin or Anything or UseDefault</mode>
        <receiveMode>AnyCode or SpecificCodeDisplay or SpecificCodeNoDisplay or RandomCode or UseDefault</receiveMode>
        <useLink>boolean</useLink>
        <textToCode>string</textToCode>
        <cellNumberProxy>string</cellNumberProxy>
        <errorDescr>string</errorDescr>
      </issueTextKeyFromUserIdResult>
    </issueTextKeyFromUserIdResponse>
  </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 /TPIServices/TextKey.asmx HTTP/1.1
Host: secure.textpower.com
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>
    <issueTextKeyFromUserId xmlns="http://www.textpower.com/services/">
      <userID>string</userID>
      <isHashed>boolean</isHashed>
    </issueTextKeyFromUserId>
  </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>
    <issueTextKeyFromUserIdResponse xmlns="http://www.textpower.com/services/">
      <issueTextKeyFromUserIdResult>
        <textKey>string</textKey>
        <status>boolean</status>
        <validationCode>string</validationCode>
        <mode>TextKeyOnly or PinCodeOnly or TextKeyPlusPin or Anything or UseDefault</mode>
        <receiveMode>AnyCode or SpecificCodeDisplay or SpecificCodeNoDisplay or RandomCode or UseDefault</receiveMode>
        <useLink>boolean</useLink>
        <textToCode>string</textToCode>
        <cellNumberProxy>string</cellNumberProxy>
        <errorDescr>string</errorDescr>
      </issueTextKeyFromUserIdResult>
    </issueTextKeyFromUserIdResponse>
  </soap12:Body>
</soap12:Envelope>