TextKeyServices


Click here for a complete list of operations.

registerTextKeyUserCSA_Key

Register TextKey User with CSA 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/registerTextKeyUserCSA_Key"

<?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>
    <registerTextKeyUserCSA_Key xmlns="http://www.textpower.com/services/">
      <apiKey>string</apiKey>
      <command>Query or AddChange or Delete</command>
      <cellNumber>string</cellNumber>
      <ownerFName>string</ownerFName>
      <ownerLName>string</ownerLName>
      <suppl1>string</suppl1>
      <suppl2>string</suppl2>
      <userID>string</userID>
      <isHashed>boolean</isHashed>
      <TextKeyMode>TextKeyOnly or PinCodeOnly or TextKeyPlusPin or Anything or UseDefault</TextKeyMode>
      <ReceiveMode>AnyCode or SpecificCodeDisplay or SpecificCodeNoDisplay or RandomCode or UseDefault</ReceiveMode>
      <pinCode>string</pinCode>
      <distressPinCode>string</distressPinCode>
      <ownerBirthDate>string</ownerBirthDate>
      <ownerGender>string</ownerGender>
      <q1>string</q1>
      <a1>string</a1>
      <q2>string</q2>
      <a2>string</a2>
      <q3>string</q3>
      <a3>string</a3>
    </registerTextKeyUserCSA_Key>
  </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>
    <registerTextKeyUserCSA_KeyResponse xmlns="http://www.textpower.com/services/">
      <registerTextKeyUserCSA_KeyResult>xml</registerTextKeyUserCSA_KeyResult>
    </registerTextKeyUserCSA_KeyResponse>
  </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>
    <registerTextKeyUserCSA_Key xmlns="http://www.textpower.com/services/">
      <apiKey>string</apiKey>
      <command>Query or AddChange or Delete</command>
      <cellNumber>string</cellNumber>
      <ownerFName>string</ownerFName>
      <ownerLName>string</ownerLName>
      <suppl1>string</suppl1>
      <suppl2>string</suppl2>
      <userID>string</userID>
      <isHashed>boolean</isHashed>
      <TextKeyMode>TextKeyOnly or PinCodeOnly or TextKeyPlusPin or Anything or UseDefault</TextKeyMode>
      <ReceiveMode>AnyCode or SpecificCodeDisplay or SpecificCodeNoDisplay or RandomCode or UseDefault</ReceiveMode>
      <pinCode>string</pinCode>
      <distressPinCode>string</distressPinCode>
      <ownerBirthDate>string</ownerBirthDate>
      <ownerGender>string</ownerGender>
      <q1>string</q1>
      <a1>string</a1>
      <q2>string</q2>
      <a2>string</a2>
      <q3>string</q3>
      <a3>string</a3>
    </registerTextKeyUserCSA_Key>
  </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>
    <registerTextKeyUserCSA_KeyResponse xmlns="http://www.textpower.com/services/">
      <registerTextKeyUserCSA_KeyResult>xml</registerTextKeyUserCSA_KeyResult>
    </registerTextKeyUserCSA_KeyResponse>
  </soap12:Body>
</soap12:Envelope>