SWGetAllDataTypes

 

Description

Return an array of data file types associated with the catalog.

Output is the list of file names and types.

If a Category is provided in the request, then it will get information related to that Category.

In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.

 

For a list of fault codes, see XML Faults.

 

Interface

 

 

<interfacename>

SWGetAllDataTypes

Name of the interface

<sessionid>

Id

Id of the active session

 

Parameters

 

<secure>

Secure

Security flag.

<category>

Category

Category

 

Return Values

 

<success>

Description

Success description

<returnval>

datafile elements

List of datafiles

<datafile>

name, type pair

Parent of <name> and <type>.

<name>

String

Name of data file

<type>

String

Name of file type

 

Fault Values

 

<faultcode>

ErrorNumber

Error code

<faultstring>

 

Description

Description of the error

 

 

Sample SOAP/XML Request

 

<SOAP-ENV:Envelope

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

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

    <SOAP-ENV:Header>

        <interfacename>SWGetAllDataTypes</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <secure>off</secure>

        </interfaceparameters>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Sample SOAP/XML Success Response

 

<SOAP-ENV:Envelope

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

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

    <SOAP-ENV:Header>

        <interfacename>SWGetAllDataTypes</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval>Available Data Files and Types are

            <datafile>

                <name>Assembly</name>

                <type>doc</type>

            </datafile>

            <datafile>

                <name>specs</name>

                <type>doc</type>

            </datafile>

 

            ... as many as appropriate

 

        </returnval>

        <success>Description</success>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Sample SOAP/XML Error Response

 

<SOAP-ENV:Envelope

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

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

    <SOAP-ENV:Header>

        <interfacename>SWGetAllDataTypes</interfacename>

        <SessionId>0000</SessionId>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval></returnval>

        <success>Description</success>

        <faultcode>0000</faultcode>

        <faultstring>Description</faultstring>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>