Gallup OMS Web Service Documentation

UpdateVariableRequest

October2010

Service:Applicants
Method:UpdateVariables
Permission:UpdateApplicantVariableRequest

Properties

Name Type Required Description
Applicant InteractionIdentifier Required
Variable VariableIdentifier Required
VariableValue String Required

Exceptions

Exception Severity Code Condition
IdentifierDoesNotExist Critical 10010002 Specified identifier does not exist.
MultipleRecordsFound Critical 10010004 Multiple records found for the identifier.
VariableDoesNotExist Critical 10110001 Specified variable name does not exist.
VariableValueNotAllowed Critical 10110002 Use of specified variable value is not allowed.
ValueMatchesExistingData NonCritical 10010005 Value provided already exists in the records.

Examples

The following is an XML example of the UpdateVariableRequest sent to the Applicants.UpdateVariables 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:UpdateVariables xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:UpdateVariableRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/Applicant">
        <a:Applicant i:type="b:InteractionIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:InteractionId>1234</b:InteractionId>
        </a:Applicant>
        <a:Variable i:nil="true" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers" />
        <a:VariableValue>MyVariableValue</a:VariableValue>
      </ns:request>
    </ns:UpdateVariables>
  </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.