Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: GetXMLDoc

Scoped Name

WSYAPIWS/XMLAPI._Parameters.GetXMLDoc

Note that this API is placed in the WYSAPIWS model.

The API is only available in the Java, WinC, WinC/iSeries versions of WebsydianExpress.

Interface

Field Variable ...as Description
WSType Input Input Specifies the type of document the references are for. The values currently used are Input, Output, Envelope, and Header.
WSObjectStoreReference Output Output The ObjectStoreReference and the ObjectDocument together identifies an XML Parser document that is loaded in TransacXML.

You use these references to access the data in the document.

WSObjectDocument Output Output

Description

The API reads the identification of an XML parser document from memory. The WSType parameter specifies the role of the document.

When the service handler is called:

The input document will contain the data loaded from the request data. The output document will not contain any data - this is the reference to the document the service handler must write the output to.

These documents are retrieved automatically by the XMLServiceHandler function. You should only have to call the GetXMLDoc API for input and output if you are creating your own specialized service handler.

In addition to this, the SoapServiceProcessor function writes values for the Soap-Envelope and the Soap-Header documents to the memory.

If you need information contained in the Soap-envelope or the Soap-headers, you can retrieve these documents using the GetXMLDoc, specifying either Envelope or Header for the WSType parameter.

Events

Universal events