Show pagesourceOld revisionsBacklinksAdd to bookExport to PDFODT exportBack to top Share via Share via... Twitter LinkedIn Facebook Pinterest Telegram WhatsApp Yammer Reddit TeamsRecent ChangesSend via e-MailPrintPermalink × Table of Contents Release 1.0B D-Serie API Endpoint overview ContactsApi DisplayApi IdentitiesApi KeyLayerApi KeysApi LocalesApi LoggingApi LuaLibrariesApi NetworkApi ProvisioningApi RemoteAccessApi SoundApi TelephonyApi TemplatesApi TimeAndDateApi UpdateApi UserInterfaceApi UsersApi Endpoint List ContactsDelete ContactsGet ContactsPost ContactsPut IdentitiesGet IdentitiesIdxGet IdentitiesIdxPut KeyLayerGet KeyLayerPut KeysGet KeysGroupGet KeysGroupKeyNumberDelete KeysGroupKeyNumberGet KeysGroupKeyNumberPost KeysGroupKeyNumberPut LocalesGet LocalesPut LoggingGet LoggingPut LuaLibrariesGet LuaLibrariesNameGet LuaLibrariesNamePut NetworkEthernetGet NetworkEthernetPut NetworkGet ProvisioningGet ProvisioningPut RemoteAccessGet RemoteAccessPut SoundGet SoundPut TelephonyGet TelephonyPut TemplatesGet TemplatesNameGet TemplatesNamePut TimeAndDateGet TimeAndDatePut UpdateGet UpdatePut UserInterfaceDisplayGet UserInterfaceDisplayPut UserInterfaceGet UserInterfacePut UsersGet UsersNameDelete UsersNameGet UsersNamePost UsersNamePut ContactsDelete ContactsGet ContactsPost ContactsPut ContactsDelete KeysGroupKeyNumberDelete UsersNameDelete UserInterfaceDisplayGet UserInterfaceDisplayPut ContactsGet IdentitiesGet IdentitiesIdxGet KeyLayerGet KeysGet KeysGroupGet KeysGroupKeyNumberGet LocalesGet LoggingGet LuaLibrariesGet LuaLibrariesNameGet NetworkEthernetGet NetworkGet ProvisioningGet RemoteAccessGet SoundGet TelephonyGet TemplatesGet TemplatesNameGet TimeAndDateGet UpdateGet UserInterfaceDisplayGet UserInterfaceGet UsersGet UsersNameGet IdentitiesGet IdentitiesIdxGet IdentitiesIdxPut KeyLayerGet KeyLayerPut KeysGet KeysGroupGet KeysGroupKeyNumberDelete KeysGroupKeyNumberGet KeysGroupKeyNumberPost KeysGroupKeyNumberPut LocalesGet LocalesPut LoggingGet LoggingPut LuaLibrariesGet LuaLibrariesNameGet LuaLibrariesNamePut NetworkEthernetGet NetworkEthernetPut NetworkGet ContactsPost KeysGroupKeyNumberPost UsersNamePost ProvisioningGet ProvisioningPut ContactsPut IdentitiesIdxPut KeyLayerPut KeysGroupKeyNumberPut LocalesPut LoggingPut LuaLibrariesNamePut NetworkEthernetPut ProvisioningPut RemoteAccessPut SoundPut TelephonyPut TemplatesNamePut TimeAndDatePut UpdatePut UserInterfaceDisplayPut UserInterfacePut UsersNamePut RemoteAccessGet RemoteAccessPut SoundGet SoundPut TelephonyGet TelephonyPut TemplatesGet TemplatesNameGet TemplatesNamePut TimeAndDateGet TimeAndDatePut UpdateGet UpdatePut UserInterfaceGet UserInterfacePut UsersGet UsersNameDelete UsersNameGet UsersNamePost UsersNamePut Models AppError BundleKey CallForwarding CallForwardingMethod CallWaiting Clir Contacts Display DoNotDisturb Ethernet ExecutionTime HttpHeader HttpReactionResponseCode HttpReactionResponseCodeAllOf HttpReactionResponseHeader HttpReactionResponseHeaderAllOf HttpRequest Identity Ipv4 Ipv6 Key KeyConfiguration KeyConfigurationOneOf KeyConfigurationOneOf1 KeyConfigurationOneOf2 KeyHttpRequest KeyHttpRequestAllOf KeyHttpRequestAllOf1 KeyIntent KeyInvite KeyInvocation KeyInvocationOneOf KeyInvocationOneOf1 KeyInvocationOneOf2 KeyInvocationOneOf3 KeyInvocationOneOf4 KeyLayer KeyReaction KeyReactionOneOf KeyReactionOneOf1 KeySetting Keys Ldap LedSetting Line Locales Logging LuaContent LuaLibrary LuaParam Messages Network Parameter Presence Provisioning RemoteAccess RemoteLog ReverseNumberLookup Rule SipProvisioning Sound Subscribe Telephony Template TimeAndDate Update User UserInterface Vlan Volumes Book Creator Add this page to your book Book Creator Remove this page from your book Manage book(0 page(s)) Help Release 1.0B XSD definition configuration D-100_D-200_1.0B-00000.xsd XSD definition minibrowser minibrowser_v01.xsd <?xml version="1.0" encoding="UTF-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="minibrowser_v01.xsd" xmlns="minibrowser_v01.xsd"> <xs:complexType name="MenuType"> <xs:annotation><xs:documentation> The menu itself may define Options as well as each single line-item. Note: Options accumulate. I.e. you cannot overwrite or delete an Option at line-item-level that was defined for the entire menu. </xs:documentation></xs:annotation> <xs:sequence> <xs:element type="textType" name="Title" maxOccurs="unbounded" minOccurs="0"/> <xs:element type="ItemType" name="Item" maxOccurs="unbounded" minOccurs="0"/> <xs:element type="ActionsType" name="AutomatedActions" maxOccurs="1" minOccurs="0" /> <xs:element type="OptionsType" name="Options" maxOccurs="1" minOccurs="0" /> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:element type="MenuType" name="Menu" /> <xs:element type="DialogType" name="Dialog" /> <xs:group name="LineAppearanceGroup"> <xs:annotation> <xs:documentation>maybe in future: enum-choice/int-range/bool/date/time</xs:documentation> </xs:annotation> <xs:choice> <xs:element type="FixedTextType" name="TextLine"/> <xs:element type="TextInputType" name="TextInput"/> </xs:choice> </xs:group> <xs:attributeGroup name="ActionAttributesGroup"> <xs:attribute type="TriggerType" name="on" use="optional" default="do it"/> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:attributeGroup> <xs:complexType name="EmptyActionType"> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:complexType> <xs:complexType name="SimpleActionType"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="ItemType"> <xs:sequence> <xs:group ref="LineAppearanceGroup"/> <xs:element type="ActionsType" name="AutomatedActions" maxOccurs="1" minOccurs="0" /> <xs:element type="OptionsType" name="Options" maxOccurs="1" minOccurs="0" /> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="TextInputType"> <xs:sequence> <xs:element name="Default" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>to pre-fill text-input-field</xs:documentation> </xs:annotation> </xs:element> <xs:element type="textType" name="Help" minOccurs="0"> <xs:annotation> <xs:documentation>shown while input is empty</xs:documentation> </xs:annotation> </xs:element> <xs:element name="InputMode" minOccurs="0"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="alphanumeric"/> <xs:enumeration value="numbersOnly"/> <xs:enumeration value="numbersPreferred"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="InputType"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="plain"/> <xs:enumeration value="password"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="Parameter" type="xs:string" default="value"/> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="textType"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute type="langType" name="lang" use="optional"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:group name="ActionsGroup"> <xs:choice> <xs:element type="URLType" name="Url"/> <xs:element type="TriggerActionType" name="Trigger"/> <!--only allowed when used within options --> <xs:element type="DialActionType" name="Dial"/> <xs:element type="SelectActionType" name="Select"/> <xs:element type="TimerActionType" name="StartTimer"/> <xs:element type="TimerActionType" name="StopTimer"/> <xs:element type="TimerActionType" name="RestartTimer"/> <xs:element type="SimpleActionType" name="Input"/> <xs:element type="EmptyActionType" name="StopSignal"/> <xs:element type="EmptyActionType" name="Beep"/> <xs:element type="EmptyActionType" name="Quit"/> <xs:element type="EmptyActionType" name="Backspace"/> <xs:element type="EmptyActionType" name="EditMode"/> <xs:element type="EmptyActionType" name="GoBack"/> <xs:element type="EmptyActionType" name="GoUp"/> <xs:element type="EmptyActionType" name="GoDown"/> <xs:element type="EmptyActionType" name="GoLeft"/> <xs:element type="EmptyActionType" name="GoRight"/> <xs:element type="EmptyActionType" name="Reload"/> </xs:choice> </xs:group> <xs:complexType name="ActionsType"> <xs:sequence> <xs:choice maxOccurs="unbounded" minOccurs="0"> <xs:group ref="ActionsGroup"/> </xs:choice> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="OptionsType"> <xs:sequence> <xs:element type="OptionType" name="Option" maxOccurs="unbounded" minOccurs="0"/> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="FixedTextType"> <xs:sequence> <xs:element name="Text" type="textType" maxOccurs="unbounded" minOccurs="0" /> <xs:element name="Help" type="textType" maxOccurs="unbounded" minOccurs="0" /> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="DialogType"> <xs:sequence> <xs:element name="Title" type="textType" maxOccurs="unbounded" minOccurs="0"/> <xs:element name="Text" type="textType" maxOccurs="unbounded" minOccurs="0"/> <xs:element name="AutomatedActions" type="ActionsType" maxOccurs="1" minOccurs="0"/> <xs:element type="OptionsType" name="Options" maxOccurs="1" minOccurs="0" /> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:complexType name="OptionType"> <xs:sequence> <xs:choice maxOccurs="unbounded" minOccurs="0"> <xs:element name="Text" type="textType"/> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> <xs:group ref="ActionsGroup"/> </xs:choice> </xs:sequence> <xs:attribute type="xs:string" name="id" use="optional"/> <xs:attribute type="xs:string" name="ref" use="optional"/> </xs:complexType> <xs:simpleType name="httpUriType"> <xs:restriction base="xs:anyURI"> <xs:pattern value="https?://.+" /> </xs:restriction> </xs:simpleType> <xs:complexType name="URLType"> <xs:simpleContent> <xs:extension base="httpUriType"> <xs:attribute type="UrlHandlingType" name="answer" default="show"/> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="SelectActionType"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute type="SelectActionLineIndexType" name="line" default="1"/> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="DialActionType"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute type="DialActionMinLenType" name="min_len" default="1"/> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="TimerActionType"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute type="xs:string" name="timer_id" default="MainTimer"/> <xs:attribute type="TimerActionTimeoutType" name="timeout" use="optional"/> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="TriggerActionType"> <xs:simpleContent> <xs:extension base="TriggerType"> <xs:attribute type="TriggerForType" name="for"/> <xs:attributeGroup ref="ActionAttributesGroup"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:simpleType name="TriggerType"> <xs:union memberTypes="enumTriggerType timeoutTriggerType xs:string"/><!--string for made-up (user defined) signals or for when comma, separating a list of std-trigger-types--> </xs:simpleType> <xs:simpleType name="enumTriggerType"> <xs:restriction base="xs:string"> <!-- triggers emitted by hard-keys or ui-gestures (e.g. touch). Some must be defined within the MB-document or they do nothing but some also have an implicit default-action that will be used so long as mb doen't define another action for the situation. --> <xs:enumeration value="do it"/> <!--OK-press or touch on item -> void if MB doesn't define an action--> <xs:enumeration value="back"/> <!--default action: <GoBack on="back, mb back"/> --> <xs:enumeration value="up"/> <!--default action: <GoUp on="up, mb up"/> --> <xs:enumeration value="down"/> <!--default action: <GoDown on="down, mb down"/> --> <xs:enumeration value="left"/> <!--default action: <GoLeft on="left, mb left"/> --> <xs:enumeration value="right"/> <!--default action: <GoRight on="right, mb right"/> --> <xs:enumeration value="make call"/> <!--default action: <DIAL on="make call, mb make call"/> --> <!-- triggers emitted by elements defined within MB-XML: --> <xs:enumeration value="mb exit"/> <xs:enumeration value="mb back"/> <xs:enumeration value="mb up"/> <xs:enumeration value="mb down"/> <xs:enumeration value="mb left"/> <xs:enumeration value="mb right"/> <xs:enumeration value="mb make call"/> <xs:enumeration value="timeout"/> <!-- screen-triggers: --> <xs:enumeration value="user activity"/> <!--any touch or key-press-interaction of user with phone--> <xs:enumeration value="come back"/><!-- after going back and now handling previous xml .. default does nothing but one could add an automated reload-action --> <xs:enumeration value="app resume"/><!-- mb-app gets opend in foreground again, without a new url, so it would display old xml .. default does nothing but one could add an automated reload-action --> <xs:enumeration value="shown"/><!-- MB is shown, either after loading Url with this screen or after COME_BACK / APP_RESUME / .. --> <xs:enumeration value="recede"/><!-- MB containing this screen is closed, either by showing another mb-screen, switching apps or terminating MB all together --> <!-- item-triggers: --> <xs:enumeration value="selected"/> <xs:enumeration value="unselected"/> <xs:enumeration value="changed"/> <!--<xs:enumeration value="shown"/> -> in item context: menu-line is shown --> <!--<xs:enumeration value="recede"/> -> in item context: menu-line is scrolled out of view --> </xs:restriction> </xs:simpleType> <xs:simpleType name="timeoutTriggerType"> <xs:restriction base="xs:string"> <xs:pattern value="timeout .+"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="langType"> <xs:restriction base="xs:string"> <xs:enumeration value="en"/> <xs:enumeration value="de"/> <xs:enumeration value="el"/><!--greek--> <xs:enumeration value="es"/> <xs:enumeration value="fr"/> <xs:enumeration value="it"/> <xs:enumeration value="nl"/> <xs:enumeration value="pl"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DialActionMinLenType"> <xs:restriction base="xs:integer"> <xs:minInclusive value="1"/> <xs:maxInclusive value="100"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SelectActionLineIndexType"> <xs:restriction base="xs:integer"> <xs:minInclusive value="1"/> <xs:maxInclusive value="100"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TimerActionTimeoutType"> <xs:restriction base="xs:string"> <xs:pattern value="[1-9][0-9]*((ms)|(sec))?"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="UrlHandlingType"> <xs:restriction base="xs:string"> <xs:enumeration value="ignore"><xs:annotation><xs:documentation> fire url but never mind the answer </xs:documentation></xs:annotation></xs:enumeration> <xs:enumeration value="show"><xs:annotation><xs:documentation> Expect Minibrowser-Menu or Dialog as answer, if it really is one of the two: show it If answer is an update: apply it, if it changes the current menu the view will adapt. Maybe in future also open Web-view on color-phones when answer is an html? </xs:documentation></xs:annotation></xs:enumeration> </xs:restriction> </xs:simpleType> <xs:simpleType name="TriggerForType"> <xs:restriction base="xs:string"> <xs:enumeration value="menu"><xs:annotation><xs:documentation> triggers all automated-actions for given trigger that are defined for this screen </xs:documentation></xs:annotation></xs:enumeration> <xs:enumeration value="item"><xs:annotation><xs:documentation> triggers all automated-actions for given trigger that are defined for the currently focused item </xs:documentation></xs:annotation></xs:enumeration> </xs:restriction> </xs:simpleType> </xs:schema> yaml API D-Serie API This is the official api documentation for the d-serie products. Version: 1.0.0 Endpoint overview ContactsApi delete / ContactsDelete: Delete a contacts setup get / ContactsGet: Get a contacts setup post / ContactsPost: Create a contacts setup put / ContactsPut: Update a contacts settings DisplayApi get / UserInterfaceDisplayGet: Get the display settings. put / UserInterfaceDisplayPut: Update the display settings. IdentitiesApi get / IdentitiesGet: Get the list of identities get / IdentitiesIdxGet: Get the specified identity at the index. put / IdentitiesIdxPut: Update the identity at the specified index. KeyLayerApi get / KeyLayerGet: Get the keylayer settings put / KeyLayerPut: Set the keylayer settings KeysApi get / KeysGet: Get all configured keys get / KeysGroupGet: Get all keys for the specified group. delete / KeysGroupKeyNumberDelete: Delete the key on the specified position in the group get / KeysGroupKeyNumberGet: Get the key on the specified position post / KeysGroupKeyNumberPost: Create a new key on the specified position put / KeysGroupKeyNumberPut: Update the key on the specified position in the group LocalesApi get / LocalesGet: Get the locale settings. put / LocalesPut: Update the locale settings. LoggingApi get / LoggingGet: Get the logging settings. put / LoggingPut: Set the logging settings. LuaLibrariesApi get / LuaLibrariesGet: Get the luaLibraries settings. get / LuaLibrariesNameGet: Get the luaLibrary with the specified name. put / LuaLibrariesNamePut: Update the luaLibrary with the specified name. NetworkApi get / NetworkEthernetGet: Get the ethernet settings. put / NetworkEthernetPut: Update the ethernet settings. get / NetworkGet: Get the network settings. ProvisioningApi get / ProvisioningGet: Get the provisionings settings. put / ProvisioningPut: Update the provisioning settings. RemoteAccessApi get / RemoteAccessGet: Get the remote-access settings. put / RemoteAccessPut: Update the remote-access settings. SoundApi get / SoundGet: Get the sound settings. put / SoundPut: Update the sound settings. TelephonyApi get / TelephonyGet: Get the telephony settings. put / TelephonyPut: Update the telephony settings. TemplatesApi get / TemplatesGet: Get all templates get / TemplatesNameGet: Get the template with the specified name. put / TemplatesNamePut: Update the template with the specified name. TimeAndDateApi get / TimeAndDateGet: Get the timeAndDate settings. put / TimeAndDatePut: Update the timeAndDate settings UpdateApi get / UpdateGet: Get the update settings. put / UpdatePut: Update the update settings. UserInterfaceApi get / UserInterfaceGet: Get settings for the user-interface. put / UserInterfacePut: Update settings for the user-interface. UsersApi get / UsersGet: Get a list of users delete / UsersNameDelete: Delete a user. The last user can not be deleted. get / UsersNameGet: Returns a single user post / UsersNamePost: Create a single user put / UsersNamePut: Update a single user Endpoint List ContactsDelete delete /contacts Description Delete a contacts setup Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } ContactsGet get /contacts Description Get a contacts setup Responses Status Code Message Response Schema 200 Operation successful contacts Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contacts" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/contacts" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPost post /contacts Description Create a contacts setup Body Parameter Name Description Required Default Pattern contactsThe setting values for a contacts setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPut put /contacts Description Update a contacts settings Body Parameter Name Description Required Default Pattern contactsThe setting values for a ldap setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } IdentitiesGet get /identities Description Get the list of identities Responses Status Code Message Response Schema 200 Operation successful array[identity] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identities" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identities" } } } } IdentitiesIdxGet get /identities/{idx} Description Get the specified identity at the index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Responses Status Code Message Response Schema 200 Operation successful identity Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identity" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identity" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } IdentitiesIdxPut put /identities/{idx} Description Update the identity at the specified index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Body Parameter Name Description Required Default Pattern identityyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerGet get /keyLayer Description Get the keylayer settings Responses Status Code Message Response Schema 200 Operation successful keyLayer Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerPut put /keyLayer Description Set the keylayer settings Body Parameter Name Description Required Default Pattern keyLayerThe keyLayer valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } KeysGet get /keys Description Get all configured keys Responses Status Code Message Response Schema 200 A list of all groups and their configured keys keys Response Schema { "description" : "A list of all groups and their configured keys", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keys" } } } } KeysGroupGet get /keys/{group} Description Get all keys for the specified group. Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull Responses Status Code Message Response Schema 200 Operation successful array[key] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberDelete delete /keys/{group}/{keyNumber} Description Delete the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberGet get /keys/{group}/{keyNumber} Description Get the key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful key Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/key" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/key" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberPost post /keys/{group}/{keyNumber} Description Create a new key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe config values for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberPut put /keys/{group}/{keyNumber} Description Update the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe updated configuration for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LocalesGet get /locales Description Get the locale settings. Responses Status Code Message Response Schema 200 Operation successful locales Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/locales" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/locales" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LocalesPut put /locales Description Update the locale settings. Body Parameter Name Description Required Default Pattern localesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingGet get /logging Description Get the logging settings. Responses Status Code Message Response Schema 200 Operation successful logging Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/logging" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/logging" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingPut put /logging Description Set the logging settings. Body Parameter Name Description Required Default Pattern loggingyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } LuaLibrariesGet get /luaLibraries Description Get the luaLibraries settings. Responses Status Code Message Response Schema 200 Operation successful array[luaLibrary] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LuaLibrariesNameGet get /luaLibraries/{name} Description Get the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Responses Status Code Message Response Schema 200 Operation successful luaLibrary Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LuaLibrariesNamePut put /luaLibraries/{name} Description Update the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Body Parameter Name Description Required Default Pattern luaLibraryyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } NetworkEthernetGet get /network/ethernet Description Get the ethernet settings. Responses Status Code Message Response Schema 200 Operation successful ethernet Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } NetworkEthernetPut put /network/ethernet Description Update the ethernet settings. Body Parameter Name Description Required Default Pattern ethernetyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } NetworkGet get /network Description Get the network settings. Responses Status Code Message Response Schema 200 Operation successful network Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/network" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/network" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ProvisioningGet get /provisioning Description Get the provisionings settings. Responses Status Code Message Response Schema 200 Operation successful provisioning Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ProvisioningPut put /provisioning Description Update the provisioning settings. Body Parameter Name Description Required Default Pattern provisioningyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } RemoteAccessGet get /remoteAccess Description Get the remote-access settings. Responses Status Code Message Response Schema 200 Operation successful remoteAccess Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } RemoteAccessPut put /remoteAccess Description Update the remote-access settings. Body Parameter Name Description Required Default Pattern remoteAccessyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundGet get /sound Description Get the sound settings. Responses Status Code Message Response Schema 200 Operation successfull sound Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sound" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/sound" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundPut put /sound Description Update the sound settings. Body Parameter Name Description Required Default Pattern soundyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyGet get /telephony Description Get the telephony settings. Responses Status Code Message Response Schema 200 Operation successfull telephony Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/telephony" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/telephony" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyPut put /telephony Description Update the telephony settings. Body Parameter Name Description Required Default Pattern telephonyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TemplatesGet get /templates Description Get all templates Responses Status Code Message Response Schema 200 A list of available key templates. array[template] Response Schema { "description" : "A list of available key templates.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/templates" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/templates" } } } } TemplatesNameGet get /templates/{name} Description Get the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Responses Status Code Message Response Schema 200 Operation successful template Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/template" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TemplatesNamePut put /templates/{name} Description Update the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Body Parameter Name Description Required Default Pattern templateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TimeAndDateGet get /timeAndDate Description Get the timeAndDate settings. Responses Status Code Message Response Schema 200 Operation successful timeAndDate Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TimeAndDatePut put /timeAndDate Description Update the timeAndDate settings Body Parameter Name Description Required Default Pattern timeAndDateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UpdateGet get /update Description Get the update settings. Responses Status Code Message Response Schema 200 Operation successful update Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/update" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/update" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UpdatePut put /update Description Update the update settings. Body Parameter Name Description Required Default Pattern updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceDisplayGet get /userInterface/display Description Get the display settings. Responses Status Code Message Response Schema 200 Operation successful display Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/display" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/display" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceDisplayPut put /userInterface/display Description Update the display settings. Body Parameter Name Description Required Default Pattern displayThe display valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UserInterfaceGet get /userInterface Description Get settings for the user-interface. Responses Status Code Message Response Schema 200 Operation successful userInterface Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfacePut put /userInterface Description Update settings for the user-interface. Body Parameter Name Description Required Default Pattern userInterfaceThe user-interface valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UsersGet get /users Description Get a list of users Responses Status Code Message Response Schema 200 Operation successful array[user] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/users" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/users" } } } } UsersNameDelete delete /users/{name} Description Delete a user. The last user can not be deleted. Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } UsersNameGet get /users/{name} Description Returns a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful user Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/user" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/user" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } UsersNamePost post /users/{name} Description Create a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user object to createyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } UsersNamePut put /users/{name} Description Update a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user properties to updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } ContactsDelete delete /contacts Description Delete a contacts setup Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } ContactsGet get /contacts Description Get a contacts setup Responses Status Code Message Response Schema 200 Operation successful contacts Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contacts" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/contacts" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPost post /contacts Description Create a contacts setup Body Parameter Name Description Required Default Pattern contactsThe setting values for a contacts setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPut put /contacts Description Update a contacts settings Body Parameter Name Description Required Default Pattern contactsThe setting values for a ldap setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsDelete delete /contacts Description Delete a contacts setup Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberDelete delete /keys/{group}/{keyNumber} Description Delete the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } UsersNameDelete delete /users/{name} Description Delete a user. The last user can not be deleted. Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } UserInterfaceDisplayGet get /userInterface/display Description Get the display settings. Responses Status Code Message Response Schema 200 Operation successful display Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/display" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/display" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceDisplayPut put /userInterface/display Description Update the display settings. Body Parameter Name Description Required Default Pattern displayThe display valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } ContactsGet get /contacts Description Get a contacts setup Responses Status Code Message Response Schema 200 Operation successful contacts Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contacts" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/contacts" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } IdentitiesGet get /identities Description Get the list of identities Responses Status Code Message Response Schema 200 Operation successful array[identity] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identities" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identities" } } } } IdentitiesIdxGet get /identities/{idx} Description Get the specified identity at the index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Responses Status Code Message Response Schema 200 Operation successful identity Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identity" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identity" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerGet get /keyLayer Description Get the keylayer settings Responses Status Code Message Response Schema 200 Operation successful keyLayer Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeysGet get /keys Description Get all configured keys Responses Status Code Message Response Schema 200 A list of all groups and their configured keys keys Response Schema { "description" : "A list of all groups and their configured keys", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keys" } } } } KeysGroupGet get /keys/{group} Description Get all keys for the specified group. Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull Responses Status Code Message Response Schema 200 Operation successful array[key] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberGet get /keys/{group}/{keyNumber} Description Get the key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful key Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/key" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/key" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LocalesGet get /locales Description Get the locale settings. Responses Status Code Message Response Schema 200 Operation successful locales Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/locales" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/locales" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingGet get /logging Description Get the logging settings. Responses Status Code Message Response Schema 200 Operation successful logging Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/logging" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/logging" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LuaLibrariesGet get /luaLibraries Description Get the luaLibraries settings. Responses Status Code Message Response Schema 200 Operation successful array[luaLibrary] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LuaLibrariesNameGet get /luaLibraries/{name} Description Get the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Responses Status Code Message Response Schema 200 Operation successful luaLibrary Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } NetworkEthernetGet get /network/ethernet Description Get the ethernet settings. Responses Status Code Message Response Schema 200 Operation successful ethernet Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } NetworkGet get /network Description Get the network settings. Responses Status Code Message Response Schema 200 Operation successful network Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/network" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/network" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ProvisioningGet get /provisioning Description Get the provisionings settings. Responses Status Code Message Response Schema 200 Operation successful provisioning Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } RemoteAccessGet get /remoteAccess Description Get the remote-access settings. Responses Status Code Message Response Schema 200 Operation successful remoteAccess Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundGet get /sound Description Get the sound settings. Responses Status Code Message Response Schema 200 Operation successfull sound Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sound" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/sound" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyGet get /telephony Description Get the telephony settings. Responses Status Code Message Response Schema 200 Operation successfull telephony Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/telephony" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/telephony" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TemplatesGet get /templates Description Get all templates Responses Status Code Message Response Schema 200 A list of available key templates. array[template] Response Schema { "description" : "A list of available key templates.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/templates" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/templates" } } } } TemplatesNameGet get /templates/{name} Description Get the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Responses Status Code Message Response Schema 200 Operation successful template Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/template" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TimeAndDateGet get /timeAndDate Description Get the timeAndDate settings. Responses Status Code Message Response Schema 200 Operation successful timeAndDate Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UpdateGet get /update Description Get the update settings. Responses Status Code Message Response Schema 200 Operation successful update Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/update" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/update" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceDisplayGet get /userInterface/display Description Get the display settings. Responses Status Code Message Response Schema 200 Operation successful display Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/display" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/display" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceGet get /userInterface Description Get settings for the user-interface. Responses Status Code Message Response Schema 200 Operation successful userInterface Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UsersGet get /users Description Get a list of users Responses Status Code Message Response Schema 200 Operation successful array[user] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/users" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/users" } } } } UsersNameGet get /users/{name} Description Returns a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful user Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/user" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/user" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } IdentitiesGet get /identities Description Get the list of identities Responses Status Code Message Response Schema 200 Operation successful array[identity] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identities" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identities" } } } } IdentitiesIdxGet get /identities/{idx} Description Get the specified identity at the index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Responses Status Code Message Response Schema 200 Operation successful identity Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/identity" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/identity" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } IdentitiesIdxPut put /identities/{idx} Description Update the identity at the specified index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Body Parameter Name Description Required Default Pattern identityyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerGet get /keyLayer Description Get the keylayer settings Responses Status Code Message Response Schema 200 Operation successful keyLayer Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keyLayer" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerPut put /keyLayer Description Set the keylayer settings Body Parameter Name Description Required Default Pattern keyLayerThe keyLayer valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } KeysGet get /keys Description Get all configured keys Responses Status Code Message Response Schema 200 A list of all groups and their configured keys keys Response Schema { "description" : "A list of all groups and their configured keys", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/keys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/keys" } } } } KeysGroupGet get /keys/{group} Description Get all keys for the specified group. Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull Responses Status Code Message Response Schema 200 Operation successful array[key] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/groupedKeys" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberDelete delete /keys/{group}/{keyNumber} Description Delete the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberGet get /keys/{group}/{keyNumber} Description Get the key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Responses Status Code Message Response Schema 200 Operation successful key Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/key" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/key" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberPost post /keys/{group}/{keyNumber} Description Create a new key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe config values for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } KeysGroupKeyNumberPut put /keys/{group}/{keyNumber} Description Update the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe updated configuration for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LocalesGet get /locales Description Get the locale settings. Responses Status Code Message Response Schema 200 Operation successful locales Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/locales" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/locales" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LocalesPut put /locales Description Update the locale settings. Body Parameter Name Description Required Default Pattern localesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingGet get /logging Description Get the logging settings. Responses Status Code Message Response Schema 200 Operation successful logging Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/logging" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/logging" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingPut put /logging Description Set the logging settings. Body Parameter Name Description Required Default Pattern loggingyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } LuaLibrariesGet get /luaLibraries Description Get the luaLibraries settings. Responses Status Code Message Response Schema 200 Operation successful array[luaLibrary] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibraries" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LuaLibrariesNameGet get /luaLibraries/{name} Description Get the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Responses Status Code Message Response Schema 200 Operation successful luaLibrary Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/luaLibrary" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LuaLibrariesNamePut put /luaLibraries/{name} Description Update the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Body Parameter Name Description Required Default Pattern luaLibraryyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } NetworkEthernetGet get /network/ethernet Description Get the ethernet settings. Responses Status Code Message Response Schema 200 Operation successful ethernet Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ethernet" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } NetworkEthernetPut put /network/ethernet Description Update the ethernet settings. Body Parameter Name Description Required Default Pattern ethernetyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } NetworkGet get /network Description Get the network settings. Responses Status Code Message Response Schema 200 Operation successful network Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/network" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/network" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPost post /contacts Description Create a contacts setup Body Parameter Name Description Required Default Pattern contactsThe setting values for a contacts setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeysGroupKeyNumberPost post /keys/{group}/{keyNumber} Description Create a new key on the specified position Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe config values for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } UsersNamePost post /users/{name} Description Create a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user object to createyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } ProvisioningGet get /provisioning Description Get the provisionings settings. Responses Status Code Message Response Schema 200 Operation successful provisioning Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/provisioning" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ProvisioningPut put /provisioning Description Update the provisioning settings. Body Parameter Name Description Required Default Pattern provisioningyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ContactsPut put /contacts Description Update a contacts settings Body Parameter Name Description Required Default Pattern contactsThe setting values for a ldap setupyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } IdentitiesIdxPut put /identities/{idx} Description Update the identity at the specified index. Path Parameters Name Description Required Default Pattern idxThe index of the identity.yesnull Body Parameter Name Description Required Default Pattern identityyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } KeyLayerPut put /keyLayer Description Set the keylayer settings Body Parameter Name Description Required Default Pattern keyLayerThe keyLayer valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } KeysGroupKeyNumberPut put /keys/{group}/{keyNumber} Description Update the key on the specified position in the group Path Parameters Name Description Required Default Pattern groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull Body Parameter Name Description Required Default Pattern keyThe updated configuration for the keyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } LocalesPut put /locales Description Update the locale settings. Body Parameter Name Description Required Default Pattern localesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } LoggingPut put /logging Description Set the logging settings. Body Parameter Name Description Required Default Pattern loggingyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } LuaLibrariesNamePut put /luaLibraries/{name} Description Update the luaLibrary with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the luaLibraryyesnull Body Parameter Name Description Required Default Pattern luaLibraryyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } NetworkEthernetPut put /network/ethernet Description Update the ethernet settings. Body Parameter Name Description Required Default Pattern ethernetyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } ProvisioningPut put /provisioning Description Update the provisioning settings. Body Parameter Name Description Required Default Pattern provisioningyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } RemoteAccessPut put /remoteAccess Description Update the remote-access settings. Body Parameter Name Description Required Default Pattern remoteAccessyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundPut put /sound Description Update the sound settings. Body Parameter Name Description Required Default Pattern soundyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyPut put /telephony Description Update the telephony settings. Body Parameter Name Description Required Default Pattern telephonyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TemplatesNamePut put /templates/{name} Description Update the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Body Parameter Name Description Required Default Pattern templateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TimeAndDatePut put /timeAndDate Description Update the timeAndDate settings Body Parameter Name Description Required Default Pattern timeAndDateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UpdatePut put /update Description Update the update settings. Body Parameter Name Description Required Default Pattern updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceDisplayPut put /userInterface/display Description Update the display settings. Body Parameter Name Description Required Default Pattern displayThe display valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UserInterfacePut put /userInterface Description Update settings for the user-interface. Body Parameter Name Description Required Default Pattern userInterfaceThe user-interface valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UsersNamePut put /users/{name} Description Update a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user properties to updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } RemoteAccessGet get /remoteAccess Description Get the remote-access settings. Responses Status Code Message Response Schema 200 Operation successful remoteAccess Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/remoteAccess" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } RemoteAccessPut put /remoteAccess Description Update the remote-access settings. Body Parameter Name Description Required Default Pattern remoteAccessyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundGet get /sound Description Get the sound settings. Responses Status Code Message Response Schema 200 Operation successfull sound Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sound" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/sound" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } SoundPut put /sound Description Update the sound settings. Body Parameter Name Description Required Default Pattern soundyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyGet get /telephony Description Get the telephony settings. Responses Status Code Message Response Schema 200 Operation successfull telephony Response Schema { "description" : "Operation successfull", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/telephony" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/telephony" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TelephonyPut put /telephony Description Update the telephony settings. Body Parameter Name Description Required Default Pattern telephonyyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TemplatesGet get /templates Description Get all templates Responses Status Code Message Response Schema 200 A list of available key templates. array[template] Response Schema { "description" : "A list of available key templates.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/templates" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/templates" } } } } TemplatesNameGet get /templates/{name} Description Get the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Responses Status Code Message Response Schema 200 Operation successful template Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/template" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TemplatesNamePut put /templates/{name} Description Update the template with the specified name. Path Parameters Name Description Required Default Pattern nameThe name of the templateyesnull Body Parameter Name Description Required Default Pattern templateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } Status Code Message Response Schema 404 NotFound Response Schema { "description" : "NotFound" } TimeAndDateGet get /timeAndDate Description Get the timeAndDate settings. Responses Status Code Message Response Schema 200 Operation successful timeAndDate Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/timeAndDate" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } TimeAndDatePut put /timeAndDate Description Update the timeAndDate settings Body Parameter Name Description Required Default Pattern timeAndDateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UpdateGet get /update Description Get the update settings. Responses Status Code Message Response Schema 200 Operation successful update Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/update" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/update" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UpdatePut put /update Description Update the update settings. Body Parameter Name Description Required Default Pattern updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfaceGet get /userInterface Description Get settings for the user-interface. Responses Status Code Message Response Schema 200 Operation successful userInterface Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/userInterface" } } } } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } UserInterfacePut put /userInterface Description Update settings for the user-interface. Body Parameter Name Description Required Default Pattern userInterfaceThe user-interface valuesyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } UsersGet get /users Description Get a list of users Responses Status Code Message Response Schema 200 Operation successful array[user] Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/users" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/users" } } } } UsersNameDelete delete /users/{name} Description Delete a user. The last user can not be deleted. Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } UsersNameGet get /users/{name} Description Returns a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Responses Status Code Message Response Schema 200 Operation successful user Response Schema { "description" : "Operation successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/user" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/user" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } UsersNamePost post /users/{name} Description Create a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user object to createyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 403 Forbidden Response Schema { "description" : "Forbidden" } UsersNamePut put /users/{name} Description Update a single user Path Parameters Name Description Required Default Pattern nameThe name of the user to fetchyesnull Body Parameter Name Description Required Default Pattern userThe user properties to updateyes Responses Status Code Message Response Schema 200 Operation successful Response Schema { "description" : "Operation successful" } Status Code Message Response Schema 400 Invalid request. AppError Response Schema { "description" : "Invalid request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AppError" } } } } Status Code Message Response Schema 401 Unauthorized Response Schema { "description" : "Unauthorized" } Status Code Message Response Schema 404 Not Found Response Schema { "description" : "Not Found" } Models AppError Field Name Required Type Description code no Integer message no String requestUnderscoreid no String BundleKey Field Name Required Type Description name yes String CallForwarding Field Name Required Type Description unconditional no callForwardingMethod busy no callForwardingMethod noResponse no callForwardingMethod CallForwardingMethod Field Name Required Type Description active yes Booleanenables call forwarding target yes String timeout no Integerthe time [s] after which the call must be forwarded CallWaiting Field Name Required Type Description active no Booleanenables the function callWaiting tone no Booleanenables the signalisation of a waiting call Clir Field Name Required Type Description active no Booleanenables the function clir Contacts Field Name Required Type Description ldap no ldap Display Field Name Required Type Description timeout no IntegerTime till lockscreen appears on no activity. Measured in milliseconds. -1 = never contrast no Integer brightness no Integer DoNotDisturb Field Name Required Type Description active no Booleanenables the function doNotDisturb Ethernet Field Name Required Type Description ipv4 no ipv4 ipv6 no ipv6 vlan no vlan ExecutionTime Field Name Required Type Description mondays no Boolean tuesdays no Boolean wednesdays no Boolean thursdays no Boolean fridays no Boolean saturdays no Boolean sundays no Boolean time no Stringa time in HH:MM format HttpHeader Field Name Required Type Description header no String value no String HttpReactionResponseCode Field Name Required Type Description responseCode no Integer dialogMessage no StringCreates a message dialog on the screen. ledColor no ledColor ledBlinking no BooleanWhether the LED should blink or not. HttpReactionResponseCodeAllOf Field Name Required Type Description responseCode no Integer dialogMessage no StringCreates a message dialog on the screen. HttpReactionResponseHeader Field Name Required Type Description dialogMessage no StringCreates a message dialog on the screen. ledColor no ledColor ledBlinking no BooleanWhether the LED should blink or not. header no String value no String HttpReactionResponseHeaderAllOf Field Name Required Type Description dialogMessage no StringCreates a message dialog on the screen. HttpRequest Field Name Required Type Description httpHeader no httpHeader httpMethod yes httpMethod uri no String httpContent no StringThe content of an HTTP request Identity Field Name Required Type Description active no Booleanenables the identity for registration username no StringThe user part of a SIP URI to register the identity password no StringThe password to authenticate the identity register displayname no StringThe display name of the identity host no StringThe host part of the identity frameSize no Integerrtp frame size in milliseconds (typically 10, 20 or 30 ms) dialplan no array[rule] audiocodecs no array[audiocodec] clir no clirType vmb no StringThe sip-username where the phone should subscribe to to get information about voice-messages. It is also used to make the call when trying to access these messages. localmoh no Booleanplays local music on hold if a call of this identity is set on hold. When enabled, held calls will take away one audio-channel. Since our phones only have 2 channels, this will limit the number of simultanious calls to two. secureConnection no BooleanActivates sips (SIP over TLS) on connections with this identity. Most likely you have to provide a certificate for the host you provided to be able to connect safely and successfully. srtp no srtpMode checkHostname no BooleanValidate the hostname against the CN of the provided Certificate. sipOverTls no BooleanUse SIP over TLS. If deactivated sips: scheme is used certificate no StringRoot certificate used as a trust anchor for the host. Text in PEM format. pickupCode no Stringused as pre code for the user part in an invite URI in case of a pickup szenario. e.g. '##06' ipVersion no ipVersion jitterBufferSize no Integer value allows a more robust communication when there are network issues. | Ipv4 Field Name Required Type Description mode yes ipv4mode address no String netmask no String gateway no String dns1 no String dns2 no String Ipv6 Field Name Required Type Description mode yes ipv6mode dns1 no String dns2 no String Key Field Name Required Type Description keyNumber yes IntegerThe number of the key label no StringThe name of the key keyConfiguration no keyConfiguration templateName no StringReference to the text element of the template name. KeyConfiguration Field Name Required Type Description lua no luaContent line no line function no keyFunction KeyConfigurationOneOf Field Name Required Type Description lua no luaContent KeyConfigurationOneOf1 Field Name Required Type Description line no line KeyConfigurationOneOf2 Field Name Required Type Description function no keyFunction KeyHttpRequest Field Name Required Type Description request no httpRequest httpReactions no array[oneOf<httpReactionResponseCode,httpReactionResponseHeader>] KeyHttpRequestAllOf Field Name Required Type Description request no httpRequest KeyHttpRequestAllOf1 Field Name Required Type Description httpReactions no array[oneOf<httpReactionResponseCode,httpReactionResponseHeader>] KeyIntent Field Name Required Type Description action yes String data no String component no String extras no array[oneOf<object,object,object>] A map of `'string': bool | int | string` KeyInvite Field Name Required Type Description uri yes String line no line KeyInvocation Field Name Required Type Description http no keyHttpRequest setting no keySetting dialog no StringCreates a message dialog on the screen. invite no keyInvite intent no keyIntent KeyInvocationOneOf Field Name Required Type Description http no keyHttpRequest KeyInvocationOneOf1 Field Name Required Type Description setting no keySetting KeyInvocationOneOf2 Field Name Required Type Description dialog no StringCreates a message dialog on the screen. KeyInvocationOneOf3 Field Name Required Type Description invite no keyInvite KeyInvocationOneOf4 Field Name Required Type Description intent no keyIntent KeyLayer Field Name Required Type Description phoneXtensions no Integer extensionModule1 no Integer extensionModule2 no Integer extensionModule3 no Integer KeyReaction Field Name Required Type Description ledSetting no ledSetting presence no presence KeyReactionOneOf Field Name Required Type Description ledSetting no ledSetting KeyReactionOneOf1 Field Name Required Type Description presence no presence KeySetting Field Name Required Type Description path yes String values no array[Object] other no ledSetting Keys Field Name Required Type Description phoneXtensions no array[key] On D-400/D-600: 60 virtual Xtension keys. On D-100/D-200: 18 (3×6) self-labeling Xtension keys. extensionModule1 no array[key] 60 Xtension keys on an extension module. extensionModule2 no array[key] 60 Xtension keys on an extension module. extensionModule3 no array[key] 60 Xtension keys on an extension module. homeScreen no array[key] 4 keys below the display Ldap Field Name Required Type Description active no Booleanuse this service or not server yes Stringldap server address fqdn or ip address ldapProtocol no ldapProtocol port no Integerldap server port 389 or 636 (LDAPS) ldapVersion no ldapVersion username yes Stringusername to login password yes StringThe password to authenticate the for the ldap server nameFilter no Stringname filter according to RFC2254 numberFilter no Stringnumber filter according to RFC2254 for reverse number lookup dialerNumberFilter no Stringnumber filter according to RFC2254 for the number suggestion list in the dialer baseDN no Stringin what scope will be used searched maxHits no Integermaximum result entries nameAttributes no Stringwhat names are you looking for numberAttributes no Stringwhat numbers are you looking for orderBy no orderNameBy reverseNumberLookupIncoming no Booleanfind contact by incoming call number reverseNumberLookupOutgoing no Booleanfind contact by outgoing call number LedSetting Field Name Required Type Description ledColor no ledColor ledBlinking no BooleanWhether the LED should blink or not. Line Field Name Required Type Description id yes String component no String Locales Field Name Required Type Description deviceLanguage no language webserverLanguage no language deviceLocation no locale Logging Field Name Required Type Description remotes no array[remoteLog] LuaContent Field Name Required Type Description code yes StringLua code to be executed for functionkeys. params no array[luaParam] LuaLibrary Field Name Required Type Description name no String code no StringLua code to be executed for functionkeys. LuaParam Field Name Required Type Description name yes String value no String Messages Field Name Required Type Description signalSeenMissedCalls no msgSignalisation signalOldMailboxMessages no msgSignalisation Network Field Name Required Type Description ethernet no ethernet Parameter Field Name Required Type Description path yes array[String] List of XPath elements within the key structure. name no String description no String optional no Boolean choice no array[String] mode no tmpParamModeEnum Presence Field Name Required Type Description subscribe yes subscribe Provisioning Field Name Required Type Description active no Booleanenables the provisioning dhcp no Booleanchecks the dhcp fields 66 and 67 for an provisioning url redirect no Booleanchecks for a provisioning redirection on connect.redirect.auerswald.de pbx no Booleanchecks via properitary sip-multicast extension for an provisioning url url no String sip no sipProvisioning execution no executionTime RemoteAccess Field Name Required Type Description webd no Booleanenable remote access via http(s) adbd no Booleanenable remote access via adb RemoteLog Field Name Required Type Description server yes StringHostname of the log server port yes IntegerPort of the log server protocol yes logProtocol filter no StringFilter to use for logging. A space-separated list of TAG[:Priority]. TAG can be \“*\” for all, Priority can be one of S:silent E:error W:warning I:info D:debug V:verbose. Default priority if omitted is [V]erbose. ReverseNumberLookup Field Name Required Type Description active no Booleanenables the function reverse phone number lookup Rule Field Name Required Type Description pattern yes String replace yes String SipProvisioning Field Name Required Type Description active no Booleanallows provisioning via sip whitelist no array[String] Sound Field Name Required Type Description defaultRingtone no ringtone volumes no volumes Subscribe Field Name Required Type Description uri yes String line no line listenFor no StringIf the subscribeType is dialog, you can specify here what to listen for. In every other case, this option is ignored. type yes subscribeType Telephony Field Name Required Type Description callWaiting no callWaiting doNotDisturb no doNotDisturb callForwarding no callForwarding clir no clir reverseNumberLookup no reverseNumberLookup defaultAudioDevice no audioDevice activeLine no line callStartTimeout no IntegerTime delay to start the call when there is no activity. Measured in milliseconds. -1 = never callAcceptTimeout no IntegerTime delay to accept an incoming call automatically. Measured in milliseconds. -1 = never Template Field Name Required Type Description name yes StringText identifying the Template. Has to be unique. Will be referenced in key structure to store which template was used. Free usable text or android resource tag prio no Integersort with prio description no String keyConfiguration yes keyConfiguration parameters no array[parameter] TimeAndDate Field Name Required Type Description ntpEnable no Boolean ntpServer no String timezone no timezone timeHourFormat no timeHourFormat Update Field Name Required Type Description check no Booleancheck for updates autoInstall no Booleanautomatically install updates if available url no String execution no executionTime User Field Name Required Type Description name yes StringThe name of the user is at the same time the unique id. password yes StringThe password for the user. If the password is provisioned, you have to supply a hashed password. You can create a compatible hash using the tool provided in the web interface at the following url: `https://<Your-IP>/#/generateHash`. Over the api, you send the password over HTTPS in clear text, where it gets hashed in the webserver. role yes role image no byte[] The image for the user, base64 encoded. The image should not exceed 300x300px. changePassword no BooleanIndicates wether a user has to change his password. This flag will only be evaluated by client side logins and any tool handling the login should honour it. UserInterface Field Name Required Type Description display no display messages no messages Vlan Field Name Required Type Description phoneActive no Boolean phoneId no Integer phonePriority no Integer workstationActive no Boolean workstationId no Integer workstationPriority no Integer Volumes Field Name Required Type Description ringing no Integervolume to use when phone is ringing headset no Integervolume-level used to play audio via headset speaker no Integervolume-level used to play audio via speaker handset no Integervolume-level used to play audio via handset en/products/comfortel-d-series/firmware/release1.0.txt Last modified: 27.01.2023 11:51by westhuis