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
  • How to set up
  • How to connect
  • Authentication
  • Limitation
  1. API guide

HTTP POST

PreviousLimits and QuotasNextOverview of a POST request

Last updated 1 year ago

Professional Premium Enterprise

It’s possible to communicate to the HTTP handler through an HTTP POST request. Within the HTTP POST specific data using key-value pairs are required in the message and send an XML string as a single parameter that includes all the objects structured in XML format.

The receiving client should parse the HTTP POST response data and extract the XML that was constructed by Ultimo Business Integration containing all the object data.

How to set up

To connect to the HTTP handler, a connector has to be created for a client. Connectors can be defined in the Ultimo Configuration Tool. A connector contains a definition of entities and properties that are available in the POST body.

Note: For more information on how to configure connectors please contact your Ultimo consultant.

How to connect

The url to send the request to:

https://customer.ultimo.net/WebServices/Connector.ashx

  • https://customer.ultimo.net

    represents the domain name where the Ultimo software is available.

  • /WebServices/Connector.ashx represents a relative path, if the Ultimo software is installed in a different directory.

Example:

Ultimo Software is located at: https://yourdomain.ultimo.net/

Then the path should be: https://yourdomain.ultimo.net/Webservices/Connector.ashx

Authentication

When sending a request using HTTP POST, authentication should be added as username & password parameters to the connection string. Therefor it is strongly recommended to use a HTTPS connection when using HTTP Post.

Limitation

When sending a request using HTTP POST, a maximum payload size of 20MB per request is accepted.

🚫
βœ…
βœ