Gallup OMS Web Service Documentation

ValidateUserByClientKeyRequest

October2010

Service:Authentication
Method:Validate
Permission:ValidateUserByClientKeyRequest

Properties

Name Type Required Description
ClientKey String Required
Client ClientIdentifier Required
RecordType RecordType Required
IPAddress String Required

Exceptions

Exception Severity Code Condition
ArgumentMissing Critical 10010001 A required request input has not been specified.
IdentifierDoesNotExist Critical 10010002 Specified identifier does not exist.
MultipleRecordsFound Critical 10010004 Multiple records found for the identifier.
DataNotFound Critical 10010006 Clien key does not exist in the client.
InvalidLogin Critical 10020001 The Username and password combination is not valid.

Examples

The following is an XML example of the ValidateUserByClientKeyRequest sent to the Authentication.Validate method. 

<soapenv:Envelope xmlns:ns="http://schemas.gallup.com/oms/2010/10/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header />
  <soapenv:Body>
    <ns:Validate xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:ValidateUserByClientKeyRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/Authentication">
        <a:ClientKey>MyClientKey</a:ClientKey>
        <a:Client i:type="b:ClientIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:ClientId>1234</b:ClientId>
        </a:Client>
        <a:RecordType>Employee</a:RecordType>
        <a:IPAddress>1.0.0.0</a:IPAddress>
      </ns:request>
    </ns:Validate>
  </soapenv:Body>
</soapenv:Envelope>

[PRINT]© Gallup, Inc. All Rights Reserved. All information contained on this site is the property of Gallup and contains proprietary trade secrets of Gallup. This information is confidential and protected under the confidentiality agreements signed by each Gallup employee, and is to be used solely by Gallup employees in the performance of their responsibilities. None of the information contained in this site is to be copied, viewed, forwarded, downloaded or shred outside of Gallup without permission.

© Gallup, Inc. All Rights Reserved. All information contained on this site is the property of Gallup and contains proprietary trade secrets of Gallup. This information is confidential and protected under the confidentiality agreements signed by each Gallup employee, and is to be used solely by Gallup employees in the performance of their responsibilities. None of the information contained in this site is to be copied, viewed, forwarded, downloaded or shred outside of Gallup without permission.