FAWAPI


Click here for a complete list of operations.

FileShareGetHeaderInfo

This method retrieves the header information for a fileshare link.

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/FileShareGetHeaderInfo"

<?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>
    <FileShareGetHeaderInfo xmlns="http://api.filesanywhere.com/">
      <FileShareKey>string</FileShareKey>
      <ClientID>string</ClientID>
      <Password>string</Password>
      <AllowedIPList>string</AllowedIPList>
    </FileShareGetHeaderInfo>
  </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>
    <FileShareGetHeaderInfoResponse xmlns="http://api.filesanywhere.com/">
      <FileShareHeaderResult>
        <ErrorMessage>string</ErrorMessage>
        <FSToken>string</FSToken>
        <SharedBy>string</SharedBy>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <RequiresPassword>string</RequiresPassword>
        <UserView>string</UserView>
        <PlayOptions>string</PlayOptions>
        <CoverPage>string</CoverPage>
        <CoverTitle>string</CoverTitle>
        <CoverDescription>string</CoverDescription>
        <WaterMark>string</WaterMark>
        <ViewOnly>string</ViewOnly>
      </FileShareHeaderResult>
    </FileShareGetHeaderInfoResponse>
  </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>
    <FileShareGetHeaderInfo xmlns="http://api.filesanywhere.com/">
      <FileShareKey>string</FileShareKey>
      <ClientID>string</ClientID>
      <Password>string</Password>
      <AllowedIPList>string</AllowedIPList>
    </FileShareGetHeaderInfo>
  </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>
    <FileShareGetHeaderInfoResponse xmlns="http://api.filesanywhere.com/">
      <FileShareHeaderResult>
        <ErrorMessage>string</ErrorMessage>
        <FSToken>string</FSToken>
        <SharedBy>string</SharedBy>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <RequiresPassword>string</RequiresPassword>
        <UserView>string</UserView>
        <PlayOptions>string</PlayOptions>
        <CoverPage>string</CoverPage>
        <CoverTitle>string</CoverTitle>
        <CoverDescription>string</CoverDescription>
        <WaterMark>string</WaterMark>
        <ViewOnly>string</ViewOnly>
      </FileShareHeaderResult>
    </FileShareGetHeaderInfoResponse>
  </soap12:Body>
</soap12:Envelope>