Gallup OMS Web Service Documentation

AddToStructureRequest

October2010

Service:People
Method:AddToStructure
Permission:AddPersonToStructureRequest

Properties

Name Type Required Description
Person InteractionIdentifier Required
Structure StructureIdentifier Required
Parent UnitInteractionIdentifier Required

Exceptions

Exception Severity Code Condition
ArgumentMissing Critical 10010001 A required request input has not been specified.
IdentifierDoesNotExist Critical 10010002 One or more of the specified identifiers does not exist.
MultipleRecordsFound Critical 10010004 Multiple records exist for the specified identifier.
DataNotFound Critical 10010006 The membership interaction for the structure does not exist in the list.
RecordAlreadyExists Critical 10010009 The child already exists in the structure.
NotUserEditable Critical 10010010 The specified structure is not editable by the user.
RelationshipNotFound Critical 10060002 The specified unit interaction identifier does not exist in the structure.
MultipleParentsFound Critical 10060006 The person specified already has a relationship to another parent in this structure.
RootNodeTampering Critical 10130001 The unit interaction identifier is the root node and it cannot be changed.

Examples

The following is an XML example of the AddToStructureRequest sent to the People.AddToStructure 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:AddToStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:AddToStructureRequest" xmlns:a="http://schemas.gallup.com/oms/2010/10/People">
        <a:Person i:type="b:InteractionIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:InteractionId>1234</b:InteractionId>
        </a:Person>
        <a:Structure i:type="b:StructureIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:StructureId>1234</b:StructureId>
        </a:Structure>
        <a:Parent i:type="b:UnitInteractionIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:InteractionId>1234</b:InteractionId>
        </a:Parent>
      </ns:request>
    </ns:AddToStructure>
  </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.