Gallup OMS Web Service Documentation

GetStructureDefinitionsByUnitRequest

October2010

Service:ReportComparisons
Method:GetStructureDefinitions
Permission:GetStructureDefinitionsByUnitRequest

Properties

Name Type Required Description
Structure StructureIdentifier Required
Unit UnitIdentifier Required
RollupType RollupType 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.

Examples

The following is an XML example of the GetStructureDefinitionsByUnitRequest sent to the ReportComparisons.GetStructureDefinitions 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:GetStructureDefinitions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <ns:request i:type="a:GetStructureDefinitionsByUnitRequest" xmlns:a="http://schemas.datacontract.org/2004/07/OMS.WCF.DataContracts.October2010.Requests.ReportComparisons">
        <a:Structure i:type="b:StructureIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:StructureId>1234</b:StructureId>
        </a:Structure>
        <a:Unit i:type="b:UnitIdIdentifier" xmlns:b="http://schemas.gallup.com/oms/2010/10/Identifiers">
          <b:UnitId>1234</b:UnitId>
        </a:Unit>
        <a:RollupType>Direct</a:RollupType>
      </ns:request>
    </ns:GetStructureDefinitions>
  </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.