FAWAPI
Click here for a complete list of operations.
IndexedItemProperties
This function indicates if the referenced file is page-indexed, for viewing in the Online Viewer. If the file is indexed, the function returns a value of 1 along with the number of indexed pages. This function can be used to check the status of a file that has been queued for indexing.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /fawapi.asmx HTTP/1.1 Host: api.filesanywhere.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://api.filesanywhere.com/IndexedItemProperties" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <IndexedItemProperties xmlns="http://api.filesanywhere.com/"> <Token>string</Token> <Path>string</Path> </IndexedItemProperties> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <IndexedItemPropertiesResponse xmlns="http://api.filesanywhere.com/"> <IndexedItemPropertiesResult> <ErrorMessage>string</ErrorMessage> <Indexed>short</Indexed> <PageNumber>long</PageNumber> </IndexedItemPropertiesResult> </IndexedItemPropertiesResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /fawapi.asmx HTTP/1.1 Host: api.filesanywhere.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <IndexedItemProperties xmlns="http://api.filesanywhere.com/"> <Token>string</Token> <Path>string</Path> </IndexedItemProperties> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <IndexedItemPropertiesResponse xmlns="http://api.filesanywhere.com/"> <IndexedItemPropertiesResult> <ErrorMessage>string</ErrorMessage> <Indexed>short</Indexed> <PageNumber>long</PageNumber> </IndexedItemPropertiesResult> </IndexedItemPropertiesResponse> </soap12:Body> </soap12:Envelope>