~~NOTOC~~
====== Get System Details ======
<label type="info">GET</label> **<nowiki>/rest/system</nowiki>**

Get information about the system, including license, date/time, and other settings.

===== REQUEST =====

==== Parameters ====
None.

==== Body ====
None.

==== Example ====
<code yaml>
GET /rest/system
</code>

===== RESPONSE =====
<panel title="200 OK" type="success">
<tabs>
  * [[#tab-res-example|Example]]
  * [[#tab-res-schema|Schema]]

<pane id="tab-res-example">
<code yaml>
{
  "build": "48",
  "company": "DuVoice",
  "datapath": "c:\\vs",
  "date": {
    "day": "25",
    "localDate": "12/25/2024",
    "month": "December",
    "weekday": "Wednesday",
    "year": "2024"
  },
  "defaultlanguage": 101,
  "dialogic": true,
  "diskfree": 750803578,
  "diskpercentfree": 75,
  "diskpercentused": 25,
  "disksize": 1000186310,
  "inetstack": "4.0.9",
  "installed": "2024/08/26 at 09:52:48 AM",
  "iso8601": "2024-12-25T15:42:57-08:00",
  "languages": [
    {
      "default": true,
      "id": 101,
      "name": "English (US)"
    },
    {
      "default": false,
      "id": 102,
      "name": "English (UK)"
    },
    {
      "default": false,
      "id": 201,
      "name": "Spanish"
    },
    {
      "default": false,
      "id": 301,
      "name": "Japanese"
    }
  ],
  "license": [
    {
      "id": 32,
      "name": "AD Server",
      "value": 0
    },
    {
      "id": 29,
      "name": "Celebrity Wakeup",
      "value": 1
    },
    {
      "id": 14,
      "name": "Demo",
      "value": 0
    },
    {
      "id": 22,
      "name": "Demo Expiration",
      "value": 0
    },
    {
      "id": 34,
      "name": "Dialogic HMP maximum",
      "value": 599
    },
    {
      "id": 28,
      "name": "DuVoice REST API Access",
      "value": 0
    },
    {
      "id": 16,
      "name": "Emergency Alert System",
      "value": 1
    },
    {
      "id": 24,
      "name": "Expiration",
      "value": 0
    },
    {
      "id": 2,
      "name": "Fax Ports",
      "value": 0
    },
    {
      "id": 10,
      "name": "Guest DID Assignment",
      "value": 1
    },
    {
      "id": 13,
      "name": "IVR",
      "value": 0
    },
    {
      "id": 9,
      "name": "InnDesk Hospitality Users",
      "value": 500
    },
    {
      "id": 11,
      "name": "Inventory System Interface",
      "value": 1
    },
    {
      "id": 8,
      "name": "Languages",
      "value": 5
    },
    {
      "id": 3,
      "name": "Mailbox Count",
      "value": 10000
    },
    {
      "id": 15,
      "name": "Martec Interface",
      "value": 0
    },
    {
      "id": 27,
      "name": "Maximum Smart Phones",
      "value": 0
    },
    {
      "id": 36,
      "name": "Message Delivery System",
      "value": 1
    },
    {
      "id": 6,
      "name": "PBX Link",
      "value": 5
    },
    {
      "id": 5,
      "name": "PMS",
      "value": 5
    },
    {
      "id": 19,
      "name": "Patient Reminder",
      "value": 0
    },
    {
      "id": 25,
      "name": "Remote Administration",
      "value": 0
    },
    {
      "id": 26,
      "name": "Remote Mailbox access",
      "value": 0
    },
    {
      "id": 12,
      "name": "Room Status Interface",
      "value": 1
    },
    {
      "id": 4,
      "name": "SIP PBX Count",
      "value": 1
    },
    {
      "id": 7,
      "name": "Serial Integration",
      "value": 1
    },
    {
      "id": 20,
      "name": "Site Locator",
      "value": 0
    },
    {
      "id": 21,
      "name": "Station Monitor",
      "value": 0
    },
    {
      "id": 23,
      "name": "Support Expiration",
      "value": 0
    },
    {
      "id": 17,
      "name": "Survey",
      "value": 0
    },
    {
      "id": 33,
      "name": "Tenant Care",
      "value": 1
    },
    {
      "id": 18,
      "name": "Test Results",
      "value": 0
    },
    {
      "id": 35,
      "name": "Type",
      "value": 0
    },
    {
      "id": 0,
      "name": "Version",
      "value": 800
    },
    {
      "id": 31,
      "name": "Virtual OS Support",
      "value": 1
    },
    {
      "id": 1,
      "name": "Voice Ports",
      "value": 80
    },
    {
      "id": 30,
      "name": "Windows Server",
      "value": 0
    }
  ],
  "licenseVersion": 800,
  "lines": 16,
  "major": "8",
  "minor": "0",
  "mongodb": true,
  "name": "DV2000",
  "registered": true,
  "released": "2024/08/26",
  "rfc1036": "Wednesday, 25 Dec 24 15:42:57 -0800",
  "rfc1123": "Wed, 25 Dec 2024 15:42:57 -0800",
  "rfc2616": "Wed, 25 Dec 2024 15:42:57 -0800",
  "running": true,
  "serialnumber": "99999",
  "setup": "2024/08/26 at 09:52:48 AM",
  "sitename": "Venture Compound",
  "smtpenabled": true,
  "time": {
    "hour": "03",
    "localTime": "03:42 pm",
    "minute": "42",
    "timezone": "-0800"
  },
  "timestamp": "20241225154257314",
  "updated": "2024/08/26 at 09:52:48 AM",
  "version": "8.0",
  "voices": [
    {
      "description": "Microsoft Catherine - English (Australia)",
      "id": "Catherine",
      "name": "Catherine - English (Australia)"
    },
    {
      "description": "Microsoft David Desktop - English (United States)",
      "id": "David",
      "name": "David - English (United States)"
    },
    {
      "description": "Microsoft George - English (United Kingdom)",
      "id": "George",
      "name": "George - English (United Kingdom)"
    },
    {
      "description": "Microsoft Hazel Desktop - English (Great Britain)",
      "id": "Hazel",
      "name": "Hazel - English (Great Britain)"
    },
    {
      "description": "Microsoft James - English (Australia)",
      "id": "James",
      "name": "James - English (Australia)"
    },
    {
      "description": "Microsoft Mark - English (United States)",
      "id": "Mark",
      "name": "Mark - English (United States)"
    },
    {
      "description": "Microsoft Susan - English (United Kingdom)",
      "id": "Susan",
      "name": "Susan - English (United Kingdom)"
    },
    {
      "description": "Microsoft Zira Desktop - English (United States)",
      "id": "Zira",
      "name": "Zira - English (United States)"
    }
  ],
  "webuiversion": "2.1.1"
}
</code>
</pane>
<pane id="tab-res-schema">
^ Name ^ Type ^ Description ^
| build | string | Build number of the system. |
| company | string | Company name. |
| datapath | string | Path to the data directory. |
| date | object | Date object containing the current date. |
| defaultlanguage | int | Default language ID. |
| dialogic | bool | Is Dialogic running. |
| diskfree | int | Amount of free disk space on data drive. |
| diskpercentfree | int | Percent free disk space on data drive. |
| diskpercentused | int | Percent of disk space used on data drive. |
| disksize | int | Size of the data drive. |
| inetstack | string | Version of the internet stack. |
| installed | string | Date and time of installation. |
| iso8601 | string | Local date and time in ISO 8601 format. |
| languages | array | Array of language objects. |
| license | array | Array of license objects. |
| licenseVersion | int | License version number. |
| lines | int | Number of lines configured. |
| major | int | Major version number.
| minor | int | Minor version number.
| mongodb | bool | Is the MongoDB database running. |
| name | string | Product name. |
| registered | bool | Are the HMP telephony lines registered. |
| released | string | Date the version installed was released. |
| rfc1036 | string | Date and time in RFC1036 format. |
| rfc1123 | string | Date and time in RFC1123 format. |
| rfc2616 | string | Date and time in RFC2616 format. |
| running | bool | Is the system running. |
| serialnumber | string | Key number of the system. |
| setup | string | Date and time setup was completed on system. |
| sitename | string | Name of the installed site. |
| smtpenabled | bool | Is SMTP available. |
| time | object | Time object containing the current time. |
| timestamp | string | Timestamp of response. |
| updated | string | Date and time system was last updated. |
| version | string | Version of the product. |
| voices | array | Array of TTS voice objects. |
| webuiversion | string | Web UI version installed. |

**date object**
^ Name ^ Type ^ Description ^
| day | int | Local day. |
| localDate | int | Local date. |
| month | string | Local month. |
| weekday | string | Local weekday. |
| year | int | Local year. |

**language object**
^ Name ^ Type ^ Description ^
| default | bool | Is this the default language. |
| id | int | Language ID. |
| name | string | Language name. |
  
**license object**
^ Name ^ Type ^ Description ^
| id | int | License ID. |
| name | string | License name. |
| value | int | License value. A value of 0 means the feature is disabled. |

**time object**
^ Name ^ Type ^ Description ^
| hour | int | Hour of day. |
| localTime | string | Local time. |
| minute | int | Local minute. |
| timezone | string | Timezone of the local system. |

**voice object**
^ Name ^ Type ^ Description ^
| description | string | Full name of the language. |
| id | string | ID to be used for language use. |
| name | string | Short name of language. |
</pane>
</tabs>
</panel>