GET api/SysProperties

Retrieves information about the installation of ContactsLaw on the server.

Request

(empty)

Response

Body

Content Type: application/xml or application/json
Basic set of system properties or an error message.

XML JSON
<Response>                                                           
  <Result>                                                           
    <Company>                                                        
      <ID>string</ID>                                                <!--Unique company ID--> 
      <FileAs>string</FileAs>                                        <!--File-as name--> 
    </Company>                                                       
    <CustomerLicensingIdentity>string</CustomerLicensingIdentity>    <!--Used by DDM--> 
    <DateFormat>string</DateFormat>                                  <!--Preferred date format (.NET)--> 
    <TimeFormat>string</TimeFormat>                                  <!--Preferred time format (.NET)--> 
    <HomeCountry>string</HomeCountry>                                <!--Country omitted for these addresses--> 
    <HomeState>string</HomeState>                                    <!--State omitted for these addresses--> 
  </Result>                                                          
  <Message>string</Message>                                          <!--Error message--> 
</Response>                                                          
{                                               
   "Result": {                                  
      "Company": {                              
         "ID": "string",                        // Unique company ID
         "FileAs": "string"                     // File-as name
      },                                        
      "CustomerLicensingIdentity": "string",    // Used by DDM
      "DateFormat": "string",                   // Preferred date format (.NET)
      "TimeFormat": "string",                   // Preferred time format (.NET)
      "HomeCountry": "string",                  // Country omitted for these addresses
      "HomeState": "string"                     // State omitted for these addresses
   },                                           
   "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.