Example send file transfer request

This section describes how to execute a SEND transfer request using Web services. After submitting a request you can retrieve transfer processing information in the Transfer CFT Local Administrator catalog using a Web services catalog search request. Responses to SEND requests may differ depending on the type of COM media file that you are using (File or TCP).

XFER_CMD_SEND_FILE request

This example request uses only the minimal number of options needed to submit the SEND file SOAP request. You can modify as needed.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:axw="http://www.axway.com">

<soapenv:Header>

<axw:ClientAuth>

<axw:user encoding="base64">user1</axw:user>

<axw:password encoding="base64">user1password</axw:password>

</axw:ClientAuth>

</soapenv:Header>

<soapenv:Body>

<axw:XFER_CMD_SEND_FILE >

<axw:IDF>TEST</axw:IDF>

<axw:FNAME>FiletoTransfer.txt</axw:FNAME>

<axw:PARTID>PARIS</axw:PARTID>

</axw:XFER_CMD_SEND_FILE>

</soapenv:Body>

</soapenv:Envelope>

Successful response

In the following successful response, you can see that the IDTU value CAT_IDTU is returned. While the IDTU value CAT_IDTU indicates that the request is correctly delivered to Transfer CFT Local Administrator, you do not know the transfer status. To obtain the transfer status, see the section describing how to use the XFER_CAT_SELECT function to view the catalog.

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

<soap:Body>

<XFER_CMD_SEND_FILEResponse >

<CAT_IDTU>A000002M</CAT_IDTU>

<RETURN_CODE>3</RETURN_CODE>

<RETURN_MESSAGE/>

</XFER_CMD_SEND_FILEResponse>

</soap:Body>

</soap:Envelope>

Note The values displayed are example values and yours results may differ.

Unsuccessful response

The request response differs depending on if Transfer CFT is running, and if the Copilot server is started, as described in the following sections.

Transfer CFT Local Administrator is down

An error message (unsuccessful response) is displayed if Copilot is running, but Transfer CFT Local Administrator is down. The following two examples demonstrate the different responses depending on the COM media type being used.

Using the TCP media type

If Transfer CFT is not started and you are using TCP, an error message is displayed.

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

<soap:Body>

<XFER_CMD_SEND_FILEResponse xmlns="http://www.axway.com">

<RETURN_CODE>7</RETURN_CODE>

<RETURN_MESSAGE>ERROR : Open channel failed  (-6006/0).

CSCcom()</RETURN_MESSAGE>

</XFER_CMD_SEND_FILEResponse>

</soap:Body>

</soap:Envelope>

Note The return code here is 7, while a successful request would return the value 3.

Using the File media type

In this scenario no IDTU value is displayed because the request is not immediately processed by Transfer CFT. Instead the request is temporarily stored in the COM file until Transfer CFT is started.

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

<soap:Body>

<XFER_CMD_SEND_FILEResponse xmlns="http://www.axway.com">

<RETURN_CODE>3</RETURN_CODE>

<RETURN_MESSAGE/>

</XFER_CMD_SEND_FILEResponse>

</soap:Body>

</soap:Envelope>

Copilot is down

If Copilot is down you get a "connection refused" type of error, regardless of whether Transfer CFT is running or not.

Related topics

Get started with Web services

Related Links