GET api/Documents/Settings

Retrieves a list containing the document libraries configured for the practice.

Request

(empty)

Response

Body

Content Type: application/xml or application/json
Data set containing the server information or an error message.

XML JSON 
<Response>                                                 
  <Result>                                                 <!--Array of 'Item'--> 
    <Item>                                                 
      <ServerID>long</ServerID>                            <!--Unique ID--> 
      <Purpose>string</Purpose>                            <!--'Library' or 'Archive'--> 
      <DocumentServer>string</DocumentServer>              <!--Hostname, port and root path--> 
      <DocumentFolder>string</DocumentFolder>              <!--Document library folder name--> 
      <WebService>string</WebService>                      
      <LastActiveSubfolder>string</LastActiveSubfolder>    
      <ClassName>string</ClassName>                        <!--Plug-in--> 
      <UseRecycleBin>bool</UseRecycleBin>                  
      <IsActive>bool</IsActive>                            
      <HexFolderNames>bool</HexFolderNames>                
    </Item>                                                
  </Result>                                                
  <Message>string</Message>                                <!--Error message--> 
</Response>                                                
{                                         
   "Result": [{                           
      "ServerID": "long",                 // Unique ID
      "Purpose": "string",                // 'Library' or 'Archive'
      "DocumentServer": "string",         // Hostname, port and root path
      "DocumentFolder": "string",         // Document library folder name
      "WebService": "string",             
      "LastActiveSubfolder": "string",    
      "ClassName": "string",              // Plug-in
      "UseRecycleBin": "bool",            
      "IsActive": "bool",                 
      "HexFolderNames": "bool"            
   }],                                    
   "Message": "string"                    // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

This operation allows a native client to connect directly to the document library (where possible). Direct access may provide better performance but requires the client and document server to be on the same network.