DCKAP Integrator
Getting StartedIntegrator StatusRoadmapRelease Notes
  • Overview
    • Enterprise Integration Platform
    • What is DCKAP Integrator?
    • Integrator Architecture
    • Integrator Security
  • GETTING STARTED
    • Quick Start Guide
    • New User Registration
      • Available Plans
    • Integrator Dashboard
    • Analytics
  • User Guide
    • The Basics
    • Account Management
      • User Groups
      • Account Settings
      • Two-Factor Authentication
    • Projects
      • Add New Project
      • Managing Projects
      • Transfer Project Ownership
    • API Access Keys
    • Project Invitations
    • Help and Support
      • Raise a Ticket
      • Visibility and Collaborators
      • Help and Support - A Quick Overview
    • Exchange
  • PROJECT MANAGER
    • Integrations
      • Add New Pipe
      • Flows and Handlers
      • Mapping and Modifiers
      • Advanced Modifiers
      • Advanced Scheduler
    • Workflows
      • Flow Builder
      • Snippets
      • Actions
        • API Call
        • Console
        • Decision
        • Loop
        • Detail Logger
        • Error Logger
        • Code Runner
        • Formatter
        • Notification
        • Snippet
        • Return
        • Sleep
      • Mock Data
      • FAQs
    • Systems
      • Credentials
      • API Manager
        • API Components
        • Test API
      • Private Systems
      • Authentication Types
        • OAuth 2.0
    • Logs
    • Project Settings
    • Project Analytics
    • Advanced
      • Flows
    • Project Documents
  • TECHNICAL GUIDE
    • Flows & Handlers
      • Add New Flow
      • Simulator
      • Flows: Best Practices
      • Flows: Use Cases
      • Timezone Converter Handler
      • Supported Timezones
    • API and Mapping
  • Tutorials
    • Create a new Integration Pipe
    • Create a new Flow
    • How to Map data?
    • Working with Modifiers
    • Managing User Groups
    • How to use DCKAP Integrator Dynamic URL's?
  • API Documentation
    • Quick Start
    • Projects API
    • Credentials API
    • Templates API
    • Posting and Reading XML data via DCKAP Integrator
    • Commonly used APIs
  • Others
    • Product Roadmap
      • Past Roadmaps
    • Release Notes
      • 4.4.0 April 29, 2025
      • 4.3.0 February 25, 2025
      • 4.2.0 December 19, 2024
      • 4.0.0 August 29, 2024
      • 3.4.8 May 27, 2024
      • 3.4.7 March 14, 2024
      • 3.4.6 January 4, 2024
      • 3.4.5 October 18, 2023
      • 3.4.4 May 16, 2023
      • 3.4.3 March 1, 2023
      • 3.4.2 December 20, 2022
      • 3.4.1 October 4, 2022
      • 3.4.0 August 10, 2022
      • 3.3.6 July 20, 2022
      • 3.3.5a June 23, 2022
      • 3.3.5 May 26, 2022
      • 3.3.4 March 31, 2022
      • 3.3.3 Feb 4, 2022
      • 3.3.2 November 24, 2021
      • 3.3.1 October 22, 2021
      • 3.3.0 August 28, 2021
      • 3.2.7 June 18, 2021
      • 3.2.6 May 11, 2021
      • 3.2.3 and 3.2.4 March 8, 2021
      • 3.2.2 Dec 24, 2020
      • 3.2.1 Nov 12, 2020
      • 3.2.0 - October 7, 2020
      • 3.1.10 - September 16, 2020
      • 3.1.9 - September 3, 2020
      • 3.1.8 - August 15, 2020
      • 3.1.7 - July 19, 2020
      • 3.1.6 - June 21, 2020
      • 3.1.5 - May 15, 2020
      • 3.1.4 - April 27, 2020
      • 3.1.3.0 - April 20, 2020
      • 3.1.3 - April 8, 2020
      • 3.1.2 - March 26, 2020
      • 3.1.1 - March 13, 2020
      • 3.1.0 - March 10, 2020
Powered by GitBook
On this page
  • POST API
  • Steps:
  • GET API
  • Steps

Was this helpful?

  1. API Documentation

Posting and Reading XML data via DCKAP Integrator

Send and receive XML data via DCKAP Integrator

PreviousTemplates APINextCommonly used APIs

Last updated 6 months ago

Was this helpful?

In order to be able to send and receive XML data via DCKAP Integrator, the steps below must be followed in both the POST and GET requests.

POST API

Steps:

  • Open the DCKAP Integrator API Manager.

  • DCKAP Integrator will allow data manipulation only in JSON format. So create the request in JSON format (expected: XML format).

  • If the API header contains 'Content-Type' as 'application/xml or text/xml'.

  • DCKAP Integrator will convert the input JSON format into XML format internally and send it to the respective APIs.

  • Next, go to the DCKAP Integrator Flows which consists of this particular API request.

  • In the Flow edit page, add the necessary handlers to consider the XML request as required by the business logic.

  • A few examples are explained below:

    1.Example 1 Adding namespace:

    • If namespace needs to be added in the request payload, add it in JSON format itself.

    • If the namespace is not added then DCKAP Integrator will assign a default namespace.

    • If namespace is not needed, assign the request payload to the 'plain_request' tag.

      • Note: Some systems will not use namespaces. For those systems, assign the JSON request payload to 'plain_request' tag before sending it to API.

Example: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://schema.b2boptic.com/b2boptic_lensorder_v1.6.3.xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:GetHeaderDetailsRequest>
         <customersOrderId>13</customersOrderId>
      </sch:GetHeaderDetailsRequest>
   </soapenv:Body>
</soapenv:Envelope>

2. Example 2 Using the Formatter Handler:

  • The formatter handler is used to stringify/dump the JSON.

Available Options

  • JSON Dumps - the output might include white-spaces.

  • JSON Dumps with separators - Eliminate white-space. To get the most compact JSON representation.

3. Example 3 GET API Call and Formatter :

  • To convert XML response to JSON

GET API

Steps

  • In order to be able to read an XML input, use the Formatter Handler and select 'Convert XML to JSON' from the dropdown list.

  • Assign the input to a variable in the Handler

DCKAP Integrator API Manager screen
Adding namespace and using the Formatter handler
Using the Formatter handler to convert XML to JSON