Ultimo Developer
  • Welcome
  • Getting started
    • Introduction
    • Software editions
  • API guide
    • REST
      • Requesting data
      • Inserting data
      • Inserting data in batch
      • File uploads
      • Query options
      • Special characters
      • Testing REST
      • Additional security
      • Limits and Quotas
    • HTTP POST
      • Overview of a POST request
      • Requesting data
      • Inserting data
      • Testing HTTP POST
      • Additional security
    • SOAP
      • Overview of a POST request
      • Requesting data
      • Inserting data
      • Testing SOAP
      • Additional security
    • Third party integration
    • Error handling
  • CONNECTORS
    • BI Platform
      • Create database user
      • Connect to the database
      • Expiring passwords
    • Exchange Online
      • Email import
      • Custom SMTP
    • LDAP
      • LDAP connector
      • Cloud vs On Premises
    • SCIM
    • OCI
    • Universal Print
      • Prerequisites & limitations
      • How to setup
  • API key Templates
    • Introduction
    • Master data
      • Cost centers
      • Departments
      • Employees
      • Service contracts
      • Suppliers
    • Assets
      • Technical Service
      • Medical Assets
      • Fleet objects
      • Infra objects
      • IT Configuration-Items
    • Jobs
      • Technical Service jobs
      • Medical jobs
      • Fleet jobs
      • Infra jobs
      • IT-incidents
      • Attach or change images
    • Article
      • Create articles
      • Create article supplier
    • IoT
      • REST
      • HTTP POST
      • SOAP
    • Reservations
      • Create reservation
      • Update reservation
      • Cancel reservation
      • Get reservations
    • Track & Trace
  • Database
    • BI overview
      • BI functions
      • BI views
  • Azure documentation
    • Terms & Conditions
    • Azure migration
      • Export alternatives
      • Import alternatives
      • LDAP
    • Setup standard Single Sign On with MS Entra ID
    • Azure Authentication
    • Azure IP addresses
    • Azure AD SCIM provisioning
  • Have a question?
    • Ask on our Customer Portal
    • Contact Customer Support
Powered by GitBook
On this page
  1. API guide
  2. SOAP

Requesting data

It is possible to retrieve data by sending a request to one of the activated export connectors. Without sending requestData, all data from the connector will be returned. It is possible to add filters to a request to retrieve specific information from the connector. Filters can be applied by adding them in the requestData node within a CDATA block.

Example request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
        <tem:ExportData>
            <tem:exportName>exportconnector</tem:exportName>
            <tem:userName>user</tem:userName>
            <tem:password>password</tem:password>
            <tem:requestData>
                <![CDATA[<Data>
                <RequestInfo>
                    <Property Name="Code" Value="[FilterValue]" />
                </RequestInfo>
            </Data>]]>
            </tem:requestData>
        </tem:ExportData>
    </soapenv:Body>
</soapenv:Envelope>

Example response

Returns the full request or an exception

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <ExportDataResponse xmlns="http://tempuri.org/">
            <ExportDataResult>
                <![CDATA[<Data>
                    <Object Type="EntityName" Action="InsertOrUpdate">
                        <Property Name="Id" Value="[FilterValue]" />
                        <Property Name="Description" Value="Object 1" />
                    </Object>
                </Data>]]>
            </ExportDataResult>
        </ExportDataResponse>
    </s:Body>
</s:Envelope>

The request and response are expected and returned in a fixed Ultimo format. With XSL transformations, it is possible to transform the request (to the Ultimo format) and response (to the desired custom format) when using XML as an output result. This is optional and can only be done by our consultants. Output can also be returned in a default CSV or JSON format.

PreviousOverview of a POST requestNextInserting data

Last updated 3 years ago