Gallup OMS Web Service Documentation

AddToStructureRequest

October2010

Service:BusinessUnits
Method:AddToStructure
Permission:AddBusinessUnitToStructureRequest

Properties

Name Type Required Description
Unit UnitInteractionIdentifier Required
Structure StructureIdentifier Required
Parent UnitInteractionIdentifier Required
UnitStructureData UnitStructureData 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.
MultipleRecordsFound Critical 10010004 Multiple records found for the identifier.
DataNotFound Critical 10010006 Interaction does not exist in the list.
RecordAlreadyExists Critical 10010009 A parent with the same child unit already exists.
NotUserEditable Critical 10010010 The Structure is not editable by the user.
RelationshipNotFound Critical 10060002 Parent unit interaction does not exist in the structure.
ParentSameAsChild Critical 10060005 Child and Parent cannot be the same.
RootNodeTampering Critical 10130001 Tampering the root node of structure is not allowed.

Examples

The following is an XML example of the AddToStructureRequest sent to the BusinessUnits.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/BusinessUnit">
        <a:Unit i:type="b:UnitInteractionIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:InteractionId>1234</b:InteractionId>
        </a:Unit>
        <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>
        <a:UnitStructureData i:nil="true" xmlns:b="http://schemas.gallup.com/oms/2010/10/Models" />
      </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.