Prev Up Next
xmlStorageSystem.mailPasswordToUser Home xmlStorageSystem.deleteMultipleFiles

Name

xmlStorageSystem.getServerCapabilities — Retrieve server specific information.

Synopsis

structure xmlStorageSystem.getServerCapabilities ( in email string ,
in password string );

Description

This method is used to obtain information about the capabilities of the server, such as files size limitations, supported types, etc...

Parameters

email

For user identification, this should be a valid email account.

password

The MD5 hash of the password.

Return Types

This method returns a structure as follows:

    'flError' boolean                   0 success, 1 fault
    'message' string                    fault message (can be used to handle error cases)
     ctBytesInUse integer               how many bytes are used on repository
     legalFileExtensions string array   which extensions are recognized
     maxBytesPerUser integer            total bytes available for this user
     maxFileSize integer                largest file size for upload (bytes)
     yourUpstreamFolderUrl string       base URL for user's blog on repository

Examples

Example24.540.Retrieving the XML Storage System Capabilities

Simple example of fetching the server capabilities.

    SQL> SOAP_CLIENT (url=>'http://example.com/xmlStorageSystem',
        operation=>'getServerCapabilities', parameters=>vector
        ('email','user@example.domain', 'password', md5('xxx'));

    SOAP response:

    <getServerCapabilitiesResponse>
       <Result>
         <ctBytesInUse>14</ctBytesInUse>
         <flError>0</flError>
           <legalFileExtensions>
             <item>ai</item>
             <item>aif</item>
             <item>aifc</item>
           </legalFileExtensions>
         <maxBytesPerUser>41943040</maxBytesPerUser>
         <maxFileSize>1048576</maxFileSize>
         <message />
         <yourUpstreamFolderUrl>http://example.com/DAV/user@example.domain/blog/</yourUpstreamFolderUrl>
       </Result>
    </getServerCapabilitiesResponse>

Prev Up Next
xmlStorageSystem.mailPasswordToUser Home xmlStorageSystem.deleteMultipleFiles