GetGeneralAppSettings API

Returns the general application settings including upload limits, work days configuration, holidays, and system preferences.

Endpoint

/srv.asmx/GetGeneralAppSettings

Methods

• GET /srv.asmx/GetGeneralAppSettings?authenticationTicket=...
• POST /srv.asmx/GetGeneralAppSettings (form data)
• SOAP Action: http://tempuri.org/GetGeneralAppSettings

Parameters

Response Structure

Success Response

<response success="true">
  <GeneralSettings>
    <UploadSettings>
      <DocumentMaxSize>78643200</DocumentMaxSize>
      <FileUploadTimeOut>900</FileUploadTimeOut>
      <DefaultUploadFileChunkSize>262144</DefaultUploadFileChunkSize>
    </UploadSettings>
    <AllowOwnershipTransfer>false</AllowOwnershipTransfer>
    <WebDav>true</WebDav>
    <DisplayAddIns>true</DisplayAddIns>
    <MinYearInDateControls>1900</MinYearInDateControls>
    <SystemRecycleBinAutoPurgeOption>0</SystemRecycleBinAutoPurgeOption>
    <MoveUsersRecycleBinToSystemRecycleBinIn>0</MoveUsersRecycleBinToSystemRecycleBinIn>
    <RerouteRedirections>false</RerouteRedirections>
    <SendDiagnosticsAndStatistics>true</SendDiagnosticsAndStatistics>
    <Workdays>
      <Monday>true</Monday>
      <Tuesday>true</Tuesday>
      <Wednesday>true</Wednesday>
      <Thursday>true</Thursday>
      <Friday>true</Friday>
      <Saturday>false</Saturday>
      <Sunday>false</Sunday>
      <StartHour>8</StartHour>
      <StartMinute>0</StartMinute>
      <EndHour>17</EndHour>
      <EndMinute>0</EndMinute>
    </Workdays>
    <HolidayList>
      <Holiday>
        <HolidayDate>2024-12-25T00:00:00</HolidayDate>
        <Description>Christmas Day</Description>
      </Holiday>
      <Holiday>
        <HolidayDate>2024-01-01T00:00:00</HolidayDate>
        <Description>New Year's Day</Description>
      </Holiday>
    </HolidayList>
    <ZipDownloadSetting>
      <Enabled>true</Enabled>
      <MaxTotalSize>78643200</MaxTotalSize>
      <MaxTotalCount>1000</MaxTotalCount>
    </ZipDownloadSetting>
    <SearchPageSize>20</SearchPageSize>
  </GeneralSettings>
</response>

Error Response

<response success="false" error="[ErrorCode] Error message" />

GeneralSettings Properties

UploadSettings Properties

Workdays Properties

ZipDownloadSetting Properties

Holiday Properties

Required Permissions

• User must be authenticated (anonymous users cannot access this API)
• No specific administrative permissions required to read settings

Use Cases

1. Client Configuration

   • Retrieve upload limits before file upload
   • Configure client-side upload chunking
   • Display appropriate date picker ranges

2. Application Integration

   • Determine WebDAV availability
   • Configure business day calculations
   • Respect system-wide preferences

3. Administration Dashboard

   • Display current system configuration
   • Monitor settings state
   • Pre-populate settings forms

Example Requests

Request (GET)

GET /srv.asmx/GetGeneralAppSettings?authenticationTicket=abc123-def456 HTTP/1.1
Host: server.example.com

Request (POST)

POST /srv.asmx/GetGeneralAppSettings HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123-def456

Request (SOAP 1.1)

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/GetGeneralAppSettings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGeneralAppSettings xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
    </GetGeneralAppSettings>
  </soap:Body>
</soap:Envelope>

Integration Examples

JavaScript/Client-Side

async function getGeneralAppSettings() {
    const ticket = getUserAuthTicket();

    const url = `/srv.asmx/GetGeneralAppSettings?authenticationTicket=${encodeURIComponent(ticket)}`;

    const response = await fetch(url);
    const xmlText = await response.text();
    const parser = new DOMParser();
    const xmlDoc = parser.parseFromString(xmlText, "text/xml");

    const root = xmlDoc.querySelector("response");
    if (root.getAttribute("success") === "true") {
        const settings = xmlDoc.querySelector("GeneralSettings");
        const uploadSettings = settings.querySelector("UploadSettings");

        return {
            uploadSettings: {
                documentMaxSize: parseInt(uploadSettings.querySelector("DocumentMaxSize").textContent),
                fileUploadTimeOut: parseInt(uploadSettings.querySelector("FileUploadTimeOut").textContent),
                defaultUploadFileChunkSize: parseInt(uploadSettings.querySelector("DefaultUploadFileChunkSize").textContent)
            },
            allowOwnershipTransfer: settings.querySelector("AllowOwnershipTransfer").textContent === "true",
            webDav: settings.querySelector("WebDav").textContent === "true",
            searchPageSize: parseInt(settings.querySelector("SearchPageSize").textContent)
        };
    } else {
        const error = root.getAttribute("error");
        throw new Error(error);
    }
}

// Usage example
async function configureUploader() {
    try {
        const settings = await getGeneralAppSettings();

        // Configure file uploader based on settings
        const maxSizeMB = settings.uploadSettings.documentMaxSize / 1024 / 1024;
        console.log(`Max upload size: ${maxSizeMB} MB`);
        console.log(`Chunk size: ${settings.uploadSettings.defaultUploadFileChunkSize} bytes`);
        console.log(`Timeout: ${settings.uploadSettings.fileUploadTimeOut} seconds`);

        // Configure uploader component
        uploader.setMaxFileSize(settings.uploadSettings.documentMaxSize);
        uploader.setChunkSize(settings.uploadSettings.defaultUploadFileChunkSize);
        uploader.setTimeout(settings.uploadSettings.fileUploadTimeOut * 1000);

    } catch (error) {
        console.error("Failed to get settings:", error);
    }
}

C# Client Usage

using (var client = new SrvSoapClient())
{
    try
    {
        var response = await client.GetGeneralAppSettingsAsync(authTicket);

        var root = XElement.Parse(response.ToString());
        if (root.Attribute("success")?.Value == "true")
        {
            var settings = root.Element("GeneralSettings");
            var uploadSettings = settings.Element("UploadSettings");

            var config = new
            {
                DocumentMaxSize = long.Parse(uploadSettings.Element("DocumentMaxSize")?.Value ?? "0"),
                FileUploadTimeOut = int.Parse(uploadSettings.Element("FileUploadTimeOut")?.Value ?? "900"),
                ChunkSize = int.Parse(uploadSettings.Element("DefaultUploadFileChunkSize")?.Value ?? "262144"),
                WebDavEnabled = bool.Parse(settings.Element("WebDav")?.Value ?? "false"),
                SearchPageSize = int.Parse(settings.Element("SearchPageSize")?.Value ?? "20")
            };

            Console.WriteLine($"Max Document Size: {config.DocumentMaxSize / 1024 / 1024} MB");
            Console.WriteLine($"Upload Timeout: {config.FileUploadTimeOut} seconds");
            Console.WriteLine($"WebDAV Enabled: {config.WebDavEnabled}");
        }
        else
        {
            var error = root.Attribute("error")?.Value;
            Console.WriteLine($"Error: {error}");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Exception: {ex.Message}");
    }
}

Notes

• DocumentMaxSize: Value in bytes. Default is 75MB (78643200 bytes), maximum is 1GB.
• DefaultUploadFileChunkSize: Minimum 256KB, maximum 32MB. Used for chunked uploads.
• SystemRecycleBinAutoPurgeOption: 0 means disabled, 1-36 represents months.
• Workdays: Used for business day calculations in workflows and due dates.
• Holidays: List of dates that should be excluded from business day calculations.

Error Codes

Common error responses:

Related APIs

• getApplicationParameters - Get basic application parameters
• SetDefaultFolderColumns - Set default folder display columns
• GetAllFolderColumns - Get all available folder columns

Version History

• Compatible with infoRouter 8.7 and later
• Settings model is serializable for client-side deserialization
• Supports both synchronous SOAP and REST access patterns

See Also

• Control Panel UI: ApplicationSettingsApply.aspx - Application settings configuration page