Example catalog search request

Use this request to search for information in the catalog, for example details about the status of a transfer request.

XFER_CAT_SELECT request with IDTU

In this example the XFER_CAT_SELECT request uses the IDTU.

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

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

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

<m:password>user1</m:password> encoding="base64"/>

</m:ClientAuth>

</SOAP-ENV:Header>

<SOAP-ENV:Body>

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

<m:CAT_FILENAME>$CFTCATA</m:CAT_FILENAME>

<m:PERSISTENCE_LOCALIZATION>PERSISTENCE_ON_WORKSTATION</m:PERSISTENCE_LOCALIZATION>

<m:PERSISTENCE_ACCESSIBILITY>PERSISTENCE_USER_ALL</m:PERSISTENCE_ACCESSIBILITY>

<m:DIRECT>BOTH</m:DIRECT>

<m:IDTU_ARRAY>

<m:IDTU>A0000030</m:IDTU>

</m:IDTU_ARRAY>

<m:CONTENT_SUBSET>

<m:CAT_CONTENT>CAT_BRIEF</m:CAT_CONTENT>

<m:SELECT_FIELDS_ARRAY>

<m:SELECT_FIELD>String</m:SELECT_FIELD>

</m:SELECT_FIELDS_ARRAY>

</m:CONTENT_SUBSET>

</m:XFER_CAT_SELECT>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Successful response

Transfer CFT Local Administrator is down

Executing the this request when Copilot is running but Transfer CFT Local Administrator is not running returns the same response.

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

<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_CAT_SELECTResponse xmlns="http://www.axway.com">

<CAT_MAXRECORDS>10000</CAT_MAXRECORDS>

<CAT_CURRENTRECORDS>12</CAT_CURRENTRECORDS>

<LISTCAT_ARRAY>

<LISTCAT_SUBSET>

<CAT_FREC>14</CAT_FREC>

<CAT_DIAGI>0</CAT_DIAGI>

<CAT_NREC>14</CAT_NREC>

<CAT_TYPE>FILE</CAT_TYPE>

<CAT_IDA>30080</CAT_IDA>

<CAT_DIAGC/>

<CAT_IDT>E0314250</CAT_IDT>

<CAT_IDF>TEST</CAT_IDF>

<CAT_DIAGP>CP NONE</CAT_DIAGP>

<CAT_PART>LOOP</CAT_PART>

<CAT_STATE>CAT_STATE_CONSUMED</CAT_STATE>

<CAT_ACK>false</CAT_ACK>

<CAT_NACK>false</CAT_NACK>

<CAT_CFTSTATE>X</CAT_CFTSTATE>

<CAT_DIRECT>SEND</CAT_DIRECT>

</LISTCAT_SUBSET>

</LISTCAT_ARRAY>

<RETURN_CODE>3</RETURN_CODE>

<RETURN_MESSAGE/>

</XFER_CAT_SELECTResponse>

</soap:Body>

</soap:Envelope>

Note To retrieve the Phase, Phasestep and  Appstate statuses you can set the CAT_CONTENT value to FULL. However, setting the catalog to FULL returns a large number of lines in the catalog.

<CAT_PHASE>X</CAT_PHASE>

<CAT_PHASESTEP>X</CAT_PHASESTEP>

<CAT_APPSTATE/>

Response when there is no IDTU

In the following response the return code is 3, successful, but the LISCAT_ARRAY is empty.

<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_CAT_SELECTResponse xmlns="http://www.axway.com">

<CAT_MAXRECORDS>10000</CAT_MAXRECORDS>

<CAT_CURRENTRECORDS>12</CAT_CURRENTRECORDS>

<LISTCAT_ARRAY/>

<RETURN_CODE>3</RETURN_CODE>

<RETURN_MESSAGE/>

</XFER_CAT_SELECTResponse>

</soap:Body>

</soap:Envelope>

Unsuccessful response

Copilot is down

The exact message text may vary depending on the selected COM media type (File or TCP).

Related topics

Get started with Web services

Related Links