Simple Object Access Protocol (SOAP) Event Triggers - EcoSys - Customization & Programming - Hexagon PPM

EcoSys Web Service API Usage Documentation

Language
English
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
8.8

Event Trigger Requests

Example SOAP message for triggering an event API. Note that the <...Options> and <...Parameters> elements are optional unless there is a required runtime parameter defined.

<SOAP-ENV:Envelope

xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<SOAP-ENV:Body>

← SOAP envelope and body

<m:SampleEventTriggerRequestElement

xmlns:m="http://ecosys.net/api/SampleEvent">

← Request element for event trigger

<SampleEventOptions>

<Username>admin</Username>

<Password>secret</Password>

<LogoutSession>true</LogoutSession>

</SampleEventOptions>

← Request options element (credentials, logging, etc.)

<SampleEventParameters>

<filter>ABC</filter>

</SampleEventParameters>

← Runtime parameters (if any defined)

</m:SampleEventTriggerRequestElement>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

← Closing tags

Event Trigger Responses

Example SOAP message response for triggering an event API.

 Any data or values are not included in an event trigger response. It will be an empty response message if successful, or a fault if failure.

<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelope xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"

xmlns:ns1="http://ecosys.net/api/SampleEvent"

xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"

xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<soapenv:Body>

← SOAP envelope and body

<ns1:SampleEventTriggerResponseElement/>

← Response element (empty)

</soapenv:Body>

</soapenv:Envelope>

← Closing tags