Gallup OMS Web Service Documentation

CreateApplicantRequest

October2010

Service:Applicants
Method:Create
Permission:CreateApplicantRequest

Properties

Name Type Required Description
Person PersonIdentifier Optional
List ListIdentifier Required
ApplicantData ApplicantData Required
AuthenticationData AuthenticationData Optional

Exceptions

Exception Severity Code Condition
ArgumentMissing Critical 10010001 A required request input has not been specified.
IdentifierDoesNotExist Critical 10010002 Specified identifier does not exist.
MultipleRecordsCannotBeCreated Critical 10010012 Multiple records cannot be created.
QuestionIdNotValid Critical 10020014 The provided Question_ID value is not valid.
ClientKeyAlreadyExists Critical 10040003 Current Client Key already exists in Client.
AccessCodeAlreadyExists Critical 10050001 Access Code already exists in List.
InteractionAlreadyExistsInList Critical 10050002 An interaction already exists in List.
LanguageIsoCodeIsInvalid Critical 10070001 The provided Language ISO code is not valid.
UserNotUpdated NonCritical 10020013 Authentication information for the user is not updated.
ClientKeyNotUpdated NonCritical 10040002 Client key value has not been updated.

Examples

The following is an XML example of the CreateApplicantRequest sent to the Applicants.Create 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:Create xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:CreateApplicantRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/Applicant">
        <a:Person i:type="b:PersonIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:PersonId>1</b:PersonId>
        </a:Person>
        <a:List i:type="b:ListIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:ListId>1234</b:ListId>
        </a:List>
        <a:ApplicantData i:nil="true" xmlns:b="http://schemas.gallup.com/oms/2010/10/Models" />
        <a:AuthenticationData i:nil="true" xmlns:b="http://schemas.gallup.com/oms/2010/10/Models" />
      </ns:request>
    </ns:Create>
  </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.