Simple Object Access Protocol (SOAP) Object Reads - EcoSys - Customization & Programming - Hexagon

EcoSys Web Service API Usage Documentation
Language
English
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
9.3

Object Read Requests

Example SOAP message for reading from an object 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:SampleObjectReadRequestElement

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

← Request element

<SampleObjectOptions>

<Username>admin</Username>

<Password>secret</Password>

<IncludeMetaData>true</IncludeMetaData>

<LogoutSession>true</LogoutSession>

</SampleObjectOptions>

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

<SampleObjectParameters>

<filter>ABC</filter>

</SampleObjectParameters>

← Runtime parameters (if any defined)

</m:SampleObjectReadRequestElement>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

← Closing tags

Object Read Responses

Example SOAP message response for reading from an object API. Note that the <Meta> and <Performance> elements will only appear if the IncludeMetaData request option is set true.

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

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

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

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:SampleObjectReadResponseElement>

← Response element

<Meta>

<ObjectCount>35</ObjectCount>

<AttributeCount>3</AttributeCount>

</Meta>

← Meta element (if requested)

<SampleObject>

<CostObjectID>Project ABC</CostObjectID>

<CostObjectName>Project ABC</CostObjectName>

<RootCostObjectID>Sample Program</RootCostObjectID>

</SampleObject>

<SampleObject>

<CostObjectID>Project ABC-DEF</CostObjectID>

<CostObjectName>Project ABC-DEF</CostObjectName>

<RootCostObjectID>Sample Program</RootCostObjectID>

</SampleObject>

. . .

← List of matching response objects

<Performance>

<ElapsedSeconds>0.250</ElapsedSeconds>

<CPUSeconds>0.094</CPUSeconds>

<DatabaseSeconds>0.048</DatabaseSeconds>

</Performance>

← Performance element (if requested), with timing metrics

</ns1:SampleObjectReadResponseElement>

</soapenv:Body>

</soapenv:Envelope>

← Closing tags