Making a Connector request - HxGN EAM - Version 11.07.01 - Customization & Programming - Hexagon

HxGN EAM Web Services Toolkit Help

Language
English (United States)
Product
HxGN EAM
Search by Category
Customization & Programming
HxGN EAM Version
11.7.1

The Connector Web Services are deployed on the Apache Axis server and the Connector Request is a SOAP request. To communicate with the HxGN EAM Connector, you need to create a SOAP request, set the security header element with the correct information, and set the body of the SOAP request with the valid function request. You may use any appropriate technology to build SOAP request such as JAX-WS, .NET, etc. The only requirement is that a SOAP envelope comply with the Connector request specification.

This request should be submitted to the endpoint URL. The destination for your SOAP message is

http://server:port/axis/services/EWSConnector, where server:port should be replaced with the actual server address where Connector is deployed, and EWSConnector is the name of the Connector service.

Connector Request example

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

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

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

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

<soapenv:Header>

<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">

<UsernameToken Id="MyID">

<Username>zoe@bigcompany</Username>

<Password> gOod47p$</</Password>

</UsernameToken>

</wsse:Security >

<Organization>Org1</Organization>

</soapenv:Header>

<soapenv:Body>

<cct:processRequest xmlns:cct="EWSConnector"/>

<ns1:MP0318_GetLocation_001 noun="Location" verb="Get" version="001" xmlns:ns1="http://schemas.datastream.net/MP_functions/MP0318_001" xmlns:dsf="http://schemas.datastream.net/MP_fields">

<dsf:LOCATIONID>

<dsf:LOCATIONCODE>TEST</dsf:LOCATIONCODE>

<dsf:ORGANIZATIONID entity="USER">

<dsf:ORGANIZATIONCODE>*</dsf:ORGANIZATIONCODE>

<dsf:DESCRIPTION/>

</dsf:ORGANIZATIONID>

<dsf:DESCRIPTION/>

</dsf:LOCATIONID>

</ns1:MP0318_GetLocation_001>

</soapenv:Body>

</soapenv:Envelope>

Connector Response example

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

<soapenv:Envelope

xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Body>

<ns1:MP0318_GetLocation_001_Result

xmlns:ns1=http://schemas.datastream.net/MP_results/MP0318_001 xmlns:ns2=http://schemas.datastream.net/MP_entities/Location_001
xmlns:dsf="http://schemas.datastream.net/MP_fields">

<ns1:ResultData>

<ns2:Location recordid="0">

<dsf:LOCATIONID>

<dsf:LOCATIONCODE>TEST</dsf:LOCATIONCODE>

<dsf:ORGANIZATIONID>

<dsf:ORGANIZATIONCODE>*</dsf:ORGANIZATIONCODE>

<dsf:DESCRIPTION>test</dsf:DESCRIPTION>

</dsf:ORGANIZATIONID>

<dsf:DESCRIPTION>test</dsf:DESCRIPTION>

</dsf:LOCATIONID>

<dsf:DEPARTMENTID>

<dsf:DEPARTMENTCODE>*</dsf:DEPARTMENTCODE>

<dsf:DESCRIPTION>DEFAULT / ALL DEPARTMENTS</dsf:DESCRIPTION>

</dsf:DEPARTMENTID>

<dsf:SAFETY>false</dsf:SAFETY>

</ns2:Location>

</ns1:ResultData>

</ns1:MP0318_GetLocation_001_Result>

</soapenv:Body>

</soapenv:Envelope>

  • Namespace prefixes such as ns1, ns2, etc., are generated during request processing and could change from request to request. You should not rely on them to retrieve a particular element via XPATH. A traversal of the DOM model of the document should be used for retrieval of particular nodes.

  • Some characters in a SOAP request or response might appear in "escaped" form. Below is an excerpt from the Extensible Markup Language (XML) 1.0 (Second Edition) specification:

  • "The ampersand character (&) and the left angle bracket (<) may appear in their literal form only when used as markup delimiters, or within a comment, a processing instruction, or a CDATA section. If they are needed elsewhere, they must be escaped using either numeric character references or the strings "&amp;" and "&lt;" respectively. The right angle bracket (>) may be represented using the string "&gt;", and must, for compatibility, be escaped using "&gt;" or a character reference when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section.

  • In the content of elements, character data is any string of characters that does not contain the start- delimiter of any markup. In a CDATA section, character data is any string of characters not including the CDATA-section-close delimiter, "]]>".

To allow attribute values to contain both single and double quotes, the apostrophe or single-quote character (') may be represented as "&apos;", and the double-quote character (") as "&quot;"."