D-100_D-200_1.0B-00000.xsd

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>

This is the official api documentation for the d-serie products.

Version: 1.0.0

• delete / ContactsDelete: Delete a contacts setup
• get / ContactsGet: Get a contacts setup
• post / ContactsPost: Create a contacts setup
• put / ContactsPut: Update a contacts settings

• get / UserInterfaceDisplayGet: Get the display settings.
• put / UserInterfaceDisplayPut: Update the display settings.

• 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.

• get / KeyLayerGet: Get the keylayer settings
• put / KeyLayerPut: Set the keylayer settings

• 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

• get / LocalesGet: Get the locale settings.
• put / LocalesPut: Update the locale settings.

• get / LoggingGet: Get the logging settings.
• put / LoggingPut: Set the logging settings.

• get / LuaLibrariesGet: Get the luaLibraries settings.
• get / LuaLibrariesNameGet: Get the luaLibrary with the specified name.
• put / LuaLibrariesNamePut: Update the luaLibrary with the specified name.

• get / NetworkEthernetGet: Get the ethernet settings.
• put / NetworkEthernetPut: Update the ethernet settings.
• get / NetworkGet: Get the network settings.

• get / ProvisioningGet: Get the provisionings settings.
• put / ProvisioningPut: Update the provisioning settings.

• get / RemoteAccessGet: Get the remote-access settings.
• put / RemoteAccessPut: Update the remote-access settings.

• get / SoundGet: Get the sound settings.
• put / SoundPut: Update the sound settings.

• get / TelephonyGet: Get the telephony settings.
• put / TelephonyPut: Update the telephony settings.

• get / TemplatesGet: Get all templates
• get / TemplatesNameGet: Get the template with the specified name.
• put / TemplatesNamePut: Update the template with the specified name.

• get / TimeAndDateGet: Get the timeAndDate settings.
• put / TimeAndDatePut: Update the timeAndDate settings

• get / UpdateGet: Get the update settings.
• put / UpdatePut: Update the update settings.

• get / UserInterfaceGet: Get settings for the user-interface.
• put / UserInterfacePut: Update settings for the user-interface.

• 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

delete /contacts

Delete a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /contacts

Get a contacts setup

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

post /contacts

Create a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /contacts

Update a contacts settings

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /identities

Get the list of identities

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identities"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identities"
      }
    }
  }
}

get /identities/{idx}

Get the specified identity at the index.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /identities/{idx}

Update the identity at the specified index.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /keyLayer

Get the keylayer settings

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /keyLayer

Set the keylayer settings

Response Schema

{
  "description" : "Operation successful"
}

get /keys

Get all configured 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"
      }
    }
  }
}

get /keys/{group}

Get all keys for the specified group.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

delete /keys/{group}/{keyNumber}

Delete the key on the specified position in the group

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /keys/{group}/{keyNumber}

Get the key on the specified position

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

post /keys/{group}/{keyNumber}

Create a new key on the specified position

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /keys/{group}/{keyNumber}

Update the key on the specified position in the group

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /locales

Get the locale settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /locales

Update the locale settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /logging

Get the logging settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /logging

Set the logging settings.

Response Schema

{
  "description" : "Operation successful"
}

get /luaLibraries

Get the luaLibraries settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /luaLibraries/{name}

Get the luaLibrary with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibrary"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibrary"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /luaLibraries/{name}

Update the luaLibrary with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /network/ethernet

Get the ethernet settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /network/ethernet

Update the ethernet settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /network

Get the network settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /provisioning

Get the provisionings settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /provisioning

Update the provisioning settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /remoteAccess

Get the remote-access settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /remoteAccess

Update the remote-access settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /sound

Get the sound settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /sound

Update the sound settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /telephony

Get the telephony settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /telephony

Update the telephony settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /templates

Get all templates

Response Schema

{
  "description" : "A list of available key templates.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    }
  }
}

get /templates/{name}

Get the template with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /templates/{name}

Update the template with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /timeAndDate

Get the timeAndDate settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /timeAndDate

Update the timeAndDate settings

Response Schema

{
  "description" : "Operation successful"
}

get /update

Get the update settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /update

Update the update settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /userInterface/display

Get the display settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /userInterface/display

Update the display settings.

Response Schema

{
  "description" : "Operation successful"
}

get /userInterface

Get settings for the user-interface.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /userInterface

Update settings for the user-interface.

Response Schema

{
  "description" : "Operation successful"
}

get /users

Get a list of users

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/users"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/users"
      }
    }
  }
}

delete /users/{name}

Delete a user. The last user can not be deleted.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Not Found"
}

get /users/{name}

Returns a single user

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Not Found"
}

post /users/{name}

Create a single user

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Forbidden"
}

put /users/{name}

Update a single user

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Not Found"
}

delete /contacts

Delete a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /contacts

Get a contacts setup

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

post /contacts

Create a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /contacts

Update a contacts settings

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

delete /contacts

Delete a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

delete /keys/{group}/{keyNumber}

Delete the key on the specified position in the group

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

delete /users/{name}

Delete a user. The last user can not be deleted.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Not Found"
}

get /userInterface/display

Get the display settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /userInterface/display

Update the display settings.

Response Schema

{
  "description" : "Operation successful"
}

get /contacts

Get a contacts setup