SWGetAttachedDoc

 

Description

Return a link to the attachment requested.

Inputs are ModelName or Category and attachment name.

Output is a link to the attachment.

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

Each request should contain either a Category or a ModelName.

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

 

For a list of fault codes, see XML Faults.

 

Interface

 

<interfacename>

SWGetAttachedDoc

 

<sessionid>

Id

Id of the active session

 

 

Parameters

<secure>

Secure

Security flag.

<model>

ModelName

Name of model

<category>

Category

Category

<type>

Assembly

Type of attachment to retrieve

 

Return Values

<success>

Description

Success description

<returnval>

Link

Link to the requested attachment

 

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>SWGetAttachedDoc</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <secure>off</secure>

            <model>ModelName</model>

            <type>Assembly</type>

            </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>SWGetAttachedDoc</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval>Link to the attachment</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>SWGetAttachedDoc</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>