openapi: 3.0.1
info: 
 description: "This is the REST interface description of the multiScan200 family. The range of functions can vary depending on the variant and software package."
 contact: 
  name: Python Examples GitHub
  url: https://github.com/SICKAG/sick_scan_rest_client
 version: 1.1.0
 title: "multiScan200 REST interface description"
servers: 
- url: http://{device}/api
  variables: 
   device: 
    default: 192.168.0.1
    description: The IP address of the multiScan200.
tags: 
- name: 1 - General
- name: 2 - Status
- name: 3 - Device Information
- name: 4 - Basic Settings
- name: 5 - Date and System Time
- name: 6 - Filter
- name: 7 - Mounting Position
- name: 8 - Contamination indication
- name: 8 - Ethernet
- name: 9 - Inputs and Outputs
- name: 10 - Measurement Data Output
- name: 11 - Data Reduction
- name: 12 - Operating Data
- name: 13 - Diagnostics
- name: 14 - Cybersecurity
- name: 15 - Field evaluation
paths: 
 /checkCredentials:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Returns authentication success. For more details see https://github.com/SICKAG/sick_scan_rest_client.'
   operationId: Post/checkCredentials
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       nullable: true
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /update:
  put: 
   tags: 
   - 1 - General
   summary: ""
   description: "Transfers a firmware file (.spk.signed) from the file location to the device. The maximum possible file size is 100 MB."
   operationId: Put/update
   requestBody:
    content: 
     application/octet-stream:
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          Type:
           type: string
          Binary:
           type: string
   responses: 
    '200':
     description: successful operation
 /crown/file:
  get: 
   tags: 
   - 13 - Diagnostics
   summary: ""
   description: "Downloads the diagnostic file (zip file) if one exists."
   operationId: Get/crown/file
   parameters: 
    - name: filePath
      in: query
      description: path
      required: true
      schema: 
       type: string
       example: diagnosisDump.zip
   responses: 
    '200':
     description: successful operation
     content: 
      application/zip: 
       schema: 
        type: string
        format: binary
    '400':
     description: bad operation
    '404':
     description: file not found
    '500':
     description: Server not found
 /parameterbackup:
  get: 
   tags: 
   - 1 - General
   summary: ""
   description: "Reads/transfers the backup file (.json) from/to the device."
   operationId: Get/parameterbackup
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        properties: 
         version:
          type: string
         device identification:
          type: string
         checksum:
          type: string
         parameters:
          type: array
          items: 
           type: object
           properties: 
            userlevel:
             $ref: '#/components/schemas/E_USER_LEVEL_TYPE'
            parameters:
             type: array
             items: 
              type: object
              properties: 
               name:
                type: string
               id:
                type: string
               value:
                oneOf:
                - type: integer
                - type: boolean
                - type: string
                - type: object
                - type: number
  put: 
   tags: 
   - 1 - General
   summary: ""
   description: "Reads/transfers the backup file (.json) from/to the device."
   operationId: Put/parameterbackup
   requestBody:
    content: 
     multipart/form-data:
      schema: 
       type: object
       properties: 
        datei:
         type: string
         format: binary
         description: Json-Datei
   responses: 
    '200':
     description: successful operation
 /DeviceIdent:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns the device name and the firmware version.'
   operationId: Get/DeviceIdent
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Name:
            type: string
            default: "multiScan200"
            maxLength: 12
           Version:
            type: string
            default: "1.1.0.0R"
            maxLength: 8
 /LocationName:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns/sets the device name.'
   operationId: Get/LocationName
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LocationName:
             type: string
             default: "not defined"
             maxLength: 32
  post: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: |
    Returns/sets the device name.

     This function requires at least user level: Authorized Client.
   operationId: Post/LocationName
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          LocationName:
           type: string
           default: "not defined"
           maxLength: 32
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /SerialNumber:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns the serial number.'
   operationId: Get/SerialNumber
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            SerialNumber:
             type: string
             default: "123456789"
             maxLength: 9
 /FirmwareVersion:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns the current firmware version.'
   operationId: Get/FirmwareVersion
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            FirmwareVersion:
             type: string
             default: "XXXXXXXXXX"
             maxLength: 40
 /SetPassword:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Sets the password for the CoLa A/B interface only. For more details see https://github.com/SICKAG/sick_scan_rest_client.'
   operationId: Post/SetPassword
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          siUserLevel:
           type: integer
          udiNewPassword:
           type: integer
         example:
          siUserLevel: 4
          udiNewPassword: 3410122659
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           bSuccess:
            type: boolean
            default: false
 /getChallenge:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: Returns a challenge for the challenge and response authentication method. For more details see https://github.com/SICKAG/sick_scan_rest_client
   operationId: Psot
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          user:
           $ref: '#/components/schemas/E_USER_LEVEL_TYPE'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         challenge:
          type: object
          properties: 
           realm:
            type: string
            default: " "
           nonce:
            type: string
            default: " "
           opaque:
            type: string
            default: " "
           salt:
            type: array
            maxItems: 16
            minItems: 0
            default: []
            items: 
             type: integer
 /changePassword:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Sets the password for the REST interface. For more details see https://github.com/SICKAG/sick_scan_rest_client.'
   operationId: Post/changePassword
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          encryptedMessage:
           type: array
           maxItems: 96
           minItems: 0
           default: []
           items: 
            type: integer
          userLevel:
           $ref: '#/components/schemas/E_USER_LEVEL_TYPE'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           result:
            type: integer
            default: 0
            enum: 
            - 0
            - 2
            - 4
            - 5
            description: >
             Mapping:
              * 0 - SUCCESS
              * 2 - NOT_ACCEPTED
              * 4 - PWD_NOT_CHANGABLE
              * 5 - TIMELOCK_ACTIVE
 /EnableUserLevel:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Activates/deactivates a specific user level for the REST interface.

     This function requires at least user level: Service.
   operationId: Post/EnableUserLevel
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          userLevel:
           type: integer
          isEnabled:
           type: boolean
           default: false
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           result:
            type: integer
            default: 0
            enum: 
            - 0
            - 2
            description: >
             Mapping:
              * 0 - SUCCESS
              * 2 - NOT_ACCEPTED
 /OrderNumber:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns the order number (SICK part number).'
   operationId: Get/OrderNumber
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            OrderNumber:
             type: string
             default: "1234567"
             maxLength: 32
 /DeviceStatus:
  get: 
   tags: 
   - 2 - Status
   summary: ""
   description: 'Returns the device state (9 possible states).'
   operationId: Get/DeviceStatus
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            DeviceStatus:
             $ref: '#/components/schemas/DeviceStatus'
 /WriteEeprom:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Saves all parameters permanently.

     This function requires at least user level: Authorized Client.
   operationId: Post/WriteEeprom
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Success:
            type: boolean
            default: False
 /SoftReset:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Reboots the device. All non-saved parameters are lost.

     This function requires at least user level: Authorized Client.
   operationId: Post/SoftReset
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          ProcessorNbr:
           type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /RebootDevice:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Reboots the device. All parameters are saved.

     This function requires at least user level: Authorized Client.
   operationId: Post/RebootDevice
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LoadFactoryDefaults:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Resets all parameters to default.

     This function requires at least user level: Service.
   operationId: Post/LoadFactoryDefaults
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LoadApplicationDefaults:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Resets all parameters except the communication interfaces.

     This function requires at least user level: Authorized Client.
   operationId: Post/LoadApplicationDefaults
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LastParaDate:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the last date (e.g. 12.11.2024) when a permanent parameter save was executed.'
   operationId: Get/LastParaDate
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LastParaDate:
             type: string
             default: "DD.MM.YYYY"
             maxLength: 10
 /LastParaTime:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the last time (e.g. 13:24) when a permanent parameter save was executed.'
   operationId: Get/LastParaTime
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LastParaTime:
             type: string
             default: "HH:MM"
             maxLength: 5
 /DoDiagnosisDump:
  post: 
   tags: 
   - 13 - Diagnostics
   summary: ""
   description: |
    Creates a diagnostic file (zip file) for further analysis.

     This function requires at least user level: Service.
   operationId: Post/DoDiagnosisDump
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          DoRunlevelLoop:
           type: boolean
           default: False
          Output:
           type: string
           default: " "
           maxLength: 64
         example:
          DoRunlevelLoop: True
          Output: 'file'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Successfull:
            type: boolean
            default: False
 /GetDiagnosisDumpInfo:
  post: 
   tags: 
   - 13 - Diagnostics
   summary: ""
   description: 'Returns additional meta-information about the diagnostic file.'
   operationId: Post/GetDiagnosisDumpInfo
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       nullable: true
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           DiagDumpExists:
            type: boolean
            default: False
           DiagDumpTimestamp:
            type: integer
 /EtherIPAddress:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns/sets the used static IP address.'
   operationId: Get/EtherIPAddress
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPAddress:
             type: array
             maxItems: 4
             minItems: 4
             default: [192,168,0,1]
             items: 
              type: integer
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Returns/sets the used static IP address.

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherIPAddress
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherIPAddress:
           type: array
           maxItems: 4
           minItems: 4
           default: [192,168,0,1]
           items: 
            type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherIPGateAddress:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns/sets the default gateway address.'
   operationId: Get/EtherIPGateAddress
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPGateAddress:
             type: array
             maxItems: 4
             minItems: 4
             default: [0,0,0,0]
             items: 
              type: integer
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Returns/sets the default gateway address.

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherIPGateAddress
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherIPGateAddress:
           type: array
           maxItems: 4
           minItems: 4
           default: [0,0,0,0]
           items: 
            type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherIPMask:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns/sets the subnet mask.'
   operationId: Get/EtherIPMask
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPMask:
             type: array
             maxItems: 4
             minItems: 4
             default: [255,255,255,0]
             items: 
              type: integer
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Returns/sets the subnet mask.

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherIPMask
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherIPMask:
           type: array
           maxItems: 4
           minItems: 4
           default: [255,255,255,0]
           items: 
            type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherAuxEnabled:
  get: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: 'Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.'
   operationId: Get/EtherAuxEnabled
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherAuxEnabled:
             type: boolean
             default: False
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: |
    Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherAuxEnabled
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherAuxEnabled:
           type: boolean
           default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherCoLaScanMode:
  get: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: 'Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.'
   operationId: Get/EtherCoLaScanMode
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherCoLaScanMode:
             type: integer
             default: 3
             enum: 
             - 0
             - 1
             - 2
             - 3
             description: >
              Mapping:
               * 0 - ENABLED
               * 1 - IP_CONFIG_DISABLED
               * 2 - DISABLED
               * 3 - IP_CONFIG_TIME_LIMIT
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: |
    Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherCoLaScanMode
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherCoLaScanMode:
           type: integer
           default: 3
           enum: 
           - 0
           - 1
           - 2
           - 3
           description: >
            Mapping:
             * 0 - ENABLED
             * 1 - IP_CONFIG_DISABLED
             * 2 - DISABLED
             * 3 - IP_CONFIG_TIME_LIMIT
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherAddressingMode:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns/sets the mode for the IP address assignment (static or DHCP).'
   operationId: Get/EtherAddressingMode
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherAddressingMode:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             description: >
              Mapping:
               * 0 - TX_IP_STATIC
               * 1 - TX_IP_DHCP
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Returns/sets the mode for the IP address assignment (static or DHCP).

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherAddressingMode
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherAddressingMode:
           type: integer
           default: 0
           enum: 
           - 0
           - 1
           description: >
            Mapping:
             * 0 - TX_IP_STATIC
             * 1 - TX_IP_DHCP
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherDHCPFallback:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns/sets the mode for the DHCP fallback (retry or static).'
   operationId: Get/EtherDHCPFallback
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherDHCPFallback:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             description: >
              Mapping:
               * 0 - TX_USE_STATIC_IP
               * 1 - TX_RETRY_DHCP
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Returns/sets the mode for the DHCP fallback (retry or static).

     This function requires at least user level: Authorized Client.
   operationId: Post/EtherDHCPFallback
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EtherDHCPFallback:
           type: integer
           default: 0
           enum: 
           - 0
           - 1
           description: >
            Mapping:
             * 0 - TX_USE_STATIC_IP
             * 1 - TX_RETRY_DHCP
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EthernetUpdate:
  post: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: |
    Applies the Ethernet settings. This needs to be executed to actually change the Ethernet settings.

     This function requires at least user level: Authorized Client.
   operationId: Post/EthernetUpdate
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /EtherIPAddressDHCP:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns the assigned DHCP IP address.'
   operationId: Get/EtherIPAddressDHCP
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPAddressDHCP:
             type: array
             maxItems: 4
             minItems: 4
             default: [192,168,0,1]
             items: 
              type: integer
 /EtherIPGateAddressDHCP:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns the assigned DHCP default gateway address.'
   operationId: Get/EtherIPGateAddressDHCP
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPGateAddressDHCP:
             type: array
             maxItems: 4
             minItems: 4
             default: [0,0,0,0]
             items: 
              type: integer
 /EtherIPMaskDHCP:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns the assigned DHCP subnet mask.'
   operationId: Get/EtherIPMaskDHCP
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherIPMaskDHCP:
             type: array
             maxItems: 4
             minItems: 4
             default: [255,255,255,0]
             items: 
              type: integer
 /httpsStatus:
  get: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: 'Returns the status of the HTTPS interface.'
   operationId: Get/httpsStatus
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           enabled:
            type: boolean
            default: False
           errorCode:
            $ref: '#/components/schemas/httpsError_t'
 /certificateBundleInfo:
  get: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: 'Returns information about the uploaded certificate bundle.'
   operationId: Get/certificateBundleInfo
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           uuidBundle:
            type: string
            default: " "
            maxLength: 100
           certificates:
            type: array
            maxItems: 4
            minItems: 0
            default: []
            items: 
             type: object
             properties: 
              names:
               type: array
               maxItems: 20
               minItems: 0
               default: []
               items: 
                type: object
                properties: 
                 entry:
                  type: string
                  default: " "
                  maxLength: 1000
              issuer:
               type: string
               default: " "
               maxLength: 1000
              subject:
               type: string
               default: " "
               maxLength: 1000
              serialNumber:
               type: string
               default: " "
               maxLength: 119
              fingerprint:
               type: string
               default: " "
               maxLength: 119
              validNotBefore:
               type: string
               default: "                        "
               maxLength: 24
               minLength: 24
              validNotAfter:
               type: string
               default: "                        "
               maxLength: 24
               minLength: 24
           errorCode:
            $ref: '#/components/schemas/httpsError_t'
 /removeCertificateBundle:
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: |
    Removes the uploaded certificate bundle.

     This function requires at least user level: Service.
   operationId: Post/removeCertificateBundle
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           success:
            type: boolean
            default: False
           errorCode:
            $ref: '#/components/schemas/httpsError_t'
 /setCertificateBundle:
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: |
    Uploads a certificate bundle in the PEM format via JSON.

     This function requires at least user level: Service.
   operationId: Post/setCertificateBundle
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          contentCertificateBundle:
           type: string
           default: " "
           maxLength: 10000
          contentPrivateKey:
           type: string
           default: " "
           maxLength: 4000
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           success:
            type: boolean
            default: False
           errorCode:
            $ref: '#/components/schemas/httpsError_t'
 /SetWebserverEnabled:
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: |
    Sets the availability of the web server (reboot required). If disabled, the web server-based GUI and the REST interface cannot be used anymore.

     This function requires at least user level: Authorized Client.
   operationId: Post/SetWebserverEnabled
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          Enable:
           type: boolean
           default: True
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /GetWebserverEnabled:
  post: 
   tags: 
   - 14 - Cybersecurity
   summary: ""
   description: 'Returns the availability of the web server.'
   operationId: Post/GetWebserverEnabled
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       nullable: true
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           IsEnabled:
            type: boolean
            default: True
 /EnableLegacyUserLevel:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Activates/deactivates a specific user level for the CoLa A/B interface.

     This function requires at least user level: Service.
   operationId: Post/EnableLegacyUserLevel
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          userLevel:
           type: integer
           minimum: 0
           maximum: 7
          isEnabled:
           type: boolean
           default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           result:
            type: boolean
            default: False
 /EtherMACAddress:
  get: 
   tags: 
   - 8 - Ethernet
   summary: ""
   description: 'Returns the MAC address of the Ethernet interface.'
   operationId: Get/EtherMACAddress
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            EtherMACAddress:
             type: array
             maxItems: 6
             minItems: 6
             default: [0,6,0x77,0,0,0]
             items: 
              type: integer
 /PowerOnCnt:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the number of power on cycles.'
   operationId: Get/PowerOnCnt
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            PowerOnCnt:
             type: integer
             default: 0
 /DailyOpHours:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the runtime duration since the last power on (non-persistent).'
   operationId: Get/DailyOpHours
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            DailyOpHours:
             type: number
             default: 0.0
 /OpHours:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the total number of operating hours during the lifetime of the device. The resolution is 1/10 hour.'
   operationId: Get/OpHours
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            OpHours:
             type: integer
             default: 0
 /DeviceType:
  get: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Returns the device type.'
   operationId: Get/DeviceType
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            DeviceType:
             type: string
             default: "multiScan2xx"
             maxLength: 18
 /RunFirmwareUpdate:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Starts the firmware update process.

     This function requires at least user level: Service.
   operationId: Post/RunFirmwareUpdate
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /UpdateState:
  get: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Returns the state of the update process.'
   operationId: Get/UpdateState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            UpdateState:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 2
             - 3
             description: >
              Mapping:
               * 0 - Initial
               * 1 - Started
               * 2 - Finished
               * 3 - Error
 /CreateParameterBackupResult:
  get: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Returns the current status of the parameter backup process.'
   operationId: Get/CreateParameterBackupResult
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Status:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - Pending
              * 1 - Finished
           Result:
            type: boolean
            default: False
 /RestoreParameterBackupResult:
  get: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Returns the current status of the parameter restoration process.'
   operationId: Get/RestoreParameterBackupResult
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Status:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - Pending
              * 1 - Finished
           RestoreResult:
            $ref: '#/components/schemas/RestoreBackupResult'
           ParametersFailedToRestore:
            type: array
            maxItems: 100
            minItems: 0
            default: []
            items: 
             type: string
             default: " "
             maxLength: 256
 /CreateParameterBackup:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Creates a parameter backup file.

     This function requires at least user level: Service.
   operationId: Post/CreateParameterBackup
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          Passphrase:
           type: string
           default: " "
           maxLength: 256
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Result:
            type: boolean
            default: False
 /RestoreParameterBackup:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: |
    Starts the backup file upload.

     This function requires at least user level: Service.
   operationId: Post/RestoreParameterBackup
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          Passphrase:
           type: string
           default: " "
           maxLength: 256
          Filter:
           type: integer
           default: 0
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Result:
            type: boolean
            default: False
 /SCdevicestate:
  get: 
   tags: 
   - 2 - Status
   summary: ""
   description: 'Returns the device state (busy, ready, or error).'
   operationId: Get/SCdevicestate
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            SCdevicestate:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 2
             description: >
              Mapping:
               * 0 - Busy
               * 1 - Ready
               * 2 - Error
 /FieldEvaluationResult:
  get: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: 'Returns the state of all possible fields.'
   operationId: Get/FieldEvaluationResult
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            FieldEvaluationResult:
             $ref: '#/components/schemas/FieldEvaluationResult_t'
 /ActivateEvaluationGroup:
  post: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: 'Sets the activation condition for all existing evaluation groups (not configured, active, or inactive).'
   operationId: Post/ActivateEvaluationGroup
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          List:
           type: array
           maxItems: 48
           minItems: 0
           default: []
           items: 
            type: object
            properties: 
             GroupId:
              type: integer
              minimum: 1
              maximum: 48
              default: 1
             Activate:
              type: boolean
              default: false
         example:
          List:
           - GroupId: 1
             Activate: True
           - GroupId: 2
             Activate: False
           - GroupId: 3
             Activate: True
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Success:
            type: array
            maxItems: 48
            minItems: 0
            default: []
            items: 
             type: boolean
             default: false
 /SetFieldEvaluationContour:
  post: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: |
    Sets the contour of an existing field.

     This function requires at least user level: Authorized Client.
   operationId: Post/SetFieldEvaluationContour
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EvaluationId:
           type: integer
          Points:
           type: array
           maxItems: 100
           minItems: 0
           default: []
           items: 
            type: object
            properties: 
             x:
              type: integer
              default: 0
             y:
              type: integer
          LowerZLimit:
           type: integer
           minimum: -100000
           maximum: 100000
          UpperZLimit:
           type: integer
           minimum: -100000
           maximum: 100000
         example:
          EvaluationId: 1
          LowerZLimit: 0
          UpperZLimit: 0
          Points:
           - x: 0
             y: -1000
           - x: 1000
             y: -1000
           - x: 1000
             y: 1000
           - x: 0
             y: 1000
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            - 3
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_INVALID_EVALUATION_ID
              * 2 - SOPAS_ERR_INVALID_POLYGON
              * 3 - SOPAS_ERR_INVALID_ZLIM
 /GetFieldEvaluationContour:
  post: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: |
    Returns the contour of an existing field.

     This function requires at least user level: Authorized Client.
   operationId: Post/GetFieldEvaluationContour
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EvaluationId:
           type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Contour:
            type: array
            maxItems: 1
            minItems: 0
            default: []
            items: 
             type: object
             properties: 
              EvaluationId:
               type: integer
              Points:
               type: array
               maxItems: 100
               minItems: 0
               default: []
               items: 
                type: object
                properties: 
                 x:
                  type: integer
                  default: 0
                 y:
                  type: integer
                  default: 0
              LowerZLimit:
               type: integer
               minimum: -100000
               maximum: 100000
              UpperZLimit:
               type: integer
               minimum: -100000
               maximum: 100000
 /SetFieldEvaluationConfiguration:
  post: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: |
    Sets the configuration of an existing field.

     This function requires at least user level: Authorized Client.
   operationId: Post/SetFieldEvaluationConfiguration
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EvaluationId:
           type: integer
          Name:
           type: string
           default: " "
           maxLength: 20
          Configuration:
           $ref: '#/components/schemas/Evaluation_t'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_INVALID_EVALUATION_ID
              * 2 - SOPAS_ERR_INVALID_CONFIGURATION
 /GetFieldEvaluationConfiguration:
  post: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: |
    Returns the configuration of an existing field.

     This function requires at least user level: Authorized Client.
   operationId: Post/GetFieldEvaluationConfiguration
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          EvaluationId:
           type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Configuration:
            type: array
            maxItems: 1
            minItems: 0
            default: []
            items: 
             type: object
             properties: 
              EvaluationId:
               type: integer
              Name:
               type: string
               default: " "
               maxLength: 20
              Configuration:
               $ref: '#/components/schemas/Evaluation_t'
 /EvaluationConfigState:
  get: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: 'Returns the performance state (OK, WWANING, EXEEDED) of an evaluation config.'
   operationId: Get/EvaluationConfigState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ActiveBeamsLimit:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - OK
              * 1 - WARNING
              * 2 - EXCEEDED
           ActiveEvaluationsLimit:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - OK
              * 1 - WARNING
              * 2 - EXCEEDED
           ActiveBeamsPerEvaluationLimit:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - OK
              * 1 - WARNING
              * 2 - EXCEEDED
           NumberOfIntersectingBeams:
            type: array
            maxItems: 48
            minItems: 0
            default: []
            items: 
             type: integer
           InputIsOutputErrorList:
            type: array
            maxItems: 48
            minItems: 0
            items: 
             type: integer
 /FieldEvaluationGroupState:
  get: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: 'Returns the activation condition for all existing evaluation groups (not configured, active, or inactive).'
   operationId: Get/FieldEvaluationGroupState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            FieldEvaluationGroupState:
             type: array
             maxItems: 48
             minItems: 48
             items: 
              type: integer
              default: 0
              enum: 
              - 0
              - 1
              - 2
              description: >
               Mapping:
                * 0 - NOT_CONFIGURED
                * 1 - ACTIVE
                * 2 - INACTIVE
 /FieldEvaluationApplicationState:
  get: 
   tags: 
   - 15 - Field evaluation
   summary: ""
   description: 'Returns the state (DEACTIVATED, ACTIVE, CONFIGURING, ERROR) of the field evaluation.'
   operationId: Get/FieldEvaluationApplicationState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            FieldEvaluationApplicationState:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 2
             - 3
             description: >
              Mapping:
               * 0 - DEACTIVATED
               * 1 - ACTIVE
               * 2 - CONFIGURING
               * 3 - ERROR
 /ContaminationConfig:
  get: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: 'Returns/sets of the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.'
   operationId: Get/ContaminationConfig
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           eStrategy:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - CM_STRATEGY_INACTIVE
              * 1 - CM_STRATEGY_HIGH_AVAILABLE
              * 2 - CM_STRATEGY_SENSITIVE
           usiResponseTime:
            type: integer
            minimum: 3
            maximum: 60
            default: 3
           eThreshold:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - CM_LOW
              * 1 - CM_MID
              * 2 - CM_HIGH
           eCover:
            type: integer
            default: 0
            enum: 
            - 0
            - 6
            - 255
            description: >
             Mapping:
              * 0 - CM_COVER_NONE
              * 6 - CM_COVER
              * 255 - CM_COVER_CUSTOM_SECTORS
           CustomSectors:
            type: array
            maxItems: 12
            minItems: 0
            default: []
            items: 
             type: boolean
             default: True
           bEnableWarning:
            type: boolean
            default: True
           bEnableError:
            type: boolean
            default: True
  post: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: |
    Returns/sets of the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.

     This function requires at least user level: Authorized Client.
   operationId: Post/ContaminationConfig
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          ContaminationConfig:
           type: object
           properties: 
            eStrategy:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 2
             description: >
              Mapping:
               * 0 - CM_STRATEGY_INACTIVE
               * 1 - CM_STRATEGY_HIGH_AVAILABLE
               * 2 - CM_STRATEGY_SENSITIVE
            usiResponseTime:
             type: integer
             minimum: 3
             maximum: 60
             default: 3
            eThreshold:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 2
             description: >
              Mapping:
               * 0 - CM_LOW
               * 1 - CM_MID
               * 2 - CM_HIGH
            eCover:
             type: integer
             default: 0
             enum: 
             - 0
             - 6
             - 255
             description: >
              Mapping:
               * 0 - CM_COVER_NONE
               * 6 - CM_COVER
               * 255 - CM_COVER_CUSTOM_SECTORS
            CustomSectors:
             type: array
             maxItems: 12
             minItems: 0
             default: []
             items: 
              type: boolean
              default: True
            bEnableWarning:
             type: boolean
             default: True
            bEnableError:
             type: boolean
             default: True
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /ContaminationActiveSectors:
  get: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: 'Element i is true, if the sector result i is included in the computation of the contamination results and false otherwise.'
   operationId: Get/ContaminationActiveSectors
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            ContaminationActiveSectors:
             type: array
             maxItems: 12
             minItems: 0
             default: []
             items: 
              type: boolean
              default: False
 /ContaminationData:
  get: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: 'Returns the contamination state of all contamination sectors.'
   operationId: Get/ContaminationData
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            ContaminationData:
             type: array
             maxItems: 12
             minItems: 0
             default: []
             items: 
              type: integer
              default: 0
              enum: 
              - 0
              - 1
              - 2
              - 3
              description: >
               Mapping:
                * 0 - CM_DATA_NONE
                * 1 - CM_DATA_CLEAN
                * 2 - CM_DATA_WARN
                * 3 - CM_DATA_ERROR
 /ContaminationResult:
  get: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: 'Returns the contamination indication state of the device.'
   operationId: Get/ContaminationResult
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           bWarningActive:
            type: boolean
            default: False
           bErrorActive:
            type: boolean
            default: False
 /treatBlockedSectorsAsErrorSectors:
  get: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: 'Returns/sets the state if blocked sectors are treated as blocked or contaminated sectors.'
   operationId: Get/treatBlockedSectorsAsErrorSectors
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            treatBlockedSectorsAsErrorSectors:
             type: boolean
             default: False
  post: 
   tags: 
   - 8 - Contamination indication
   summary: ""
   description: |
    Returns/sets the state if blocked sectors are treated as blocked or contaminated sectors.

     This function requires at least user level: Authorized Client.
   operationId: Post/treatBlockedSectorsAsErrorSectors
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          treatBlockedSectorsAsErrorSectors:
           type: boolean
           default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /dataOutputMode:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the data output mode (e.g. Compact format) or disables scan data transmission.'
   operationId: Get/dataOutputMode
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            dataOutputMode:
             type: integer
             default: 1
             enum: 
             - 0
             - 1
             - 3
             description: >
              Mapping:
               * 0 - DISABLED
               * 1 - TCP_COMPACT
               * 3 - NATIVE_ROS_2
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the data output mode (e.g. Compact format) or disables scan data transmission.

     This function requires at least user level: Authorized Client.
   operationId: Post/dataOutputMode
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          dataOutputMode:
           type: integer
           default: 1
           enum: 
           - 0
           - 1
           - 3
           description: >
            Mapping:
             * 0 - DISABLED
             * 1 - TCP_COMPACT
             * 3 - NATIVE_ROS_2
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LFPintervalFilter:
  get: 
   tags: 
   - 11 - Data Reduction
   summary: ""
   description: 'Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.'
   operationId: Get/LFPintervalFilter
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           bEnable:
            type: boolean
            default: False
           uiReductionFactor:
            type: integer
            minimum: 2
            maximum: 50
            default: 2
  post: 
   tags: 
   - 11 - Data Reduction
   summary: ""
   description: |
    Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.

     This function requires at least user level: Authorized Client.
   operationId: Post/LFPintervalFilter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          LFPintervalFilter:
           type: object
           properties: 
            bEnable:
             type: boolean
             default: False
            uiReductionFactor:
             type: integer
             minimum: 2
             maximum: 50
             default: 2
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /enableHighPrecisionMode:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the high precision mode (temporal moving averaging).'
   operationId: Get/enableHighPrecisionMode
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            enableHighPrecisionMode:
             type: boolean
             default: False
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the high precision mode (temporal moving averaging).

     This function requires at least user level: Authorized Client.
   operationId: Post/enableHighPrecisionMode
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          enableHighPrecisionMode:
           type: boolean
           default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /angleRangeFocusFilter:
  get: 
   tags: 
   - 11 - Data Reduction
   summary: ""
   description: 'Returns/sets the angle range focus filter settings.'
   operationId: Get/angleRangeFocusFilter
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           enable:
            type: boolean
            default: False
           thetaStart:
            type: integer
            minimum: -1800000
            maximum: 1800000
            default: -900000
           thetaStop:
            type: integer
            minimum: -1800000
            maximum: 1800000
            default: 900000
           phiStart:
            type: integer
            minimum: -900000
            maximum: 900000
            default: -250000
           phiStop:
            type: integer
            minimum: -900000
            maximum: 900000
            default: 250000
           thetaIndexIncrement:
            type: integer
            minimum: 1
            maximum: 50
            default: 1
           phiIndexIncrement:
            type: integer
            minimum: 1
            maximum: 50
            default: 1
           focusRegion:
            type: object
            properties: 
             enable:
              type: boolean
              default: False
             direction:
              type: integer
              default: 0
              enum: 
              - 0
              - 1
              description: >
               Mapping:
                * 0 - HORIZONTAL
                * 1 - VERTICAL
             thetaStart:
              type: integer
              minimum: -1800000
              maximum: 1800000
              default: -450000
             thetaStop:
              type: integer
              minimum: -1800000
              maximum: 1800000
              default: 450000
             phiStart:
              type: integer
              minimum: -900000
              maximum: 900000
              default: -100000
             phiStop:
              type: integer
              minimum: -900000
              maximum: 900000
              default: 100000
  post: 
   tags: 
   - 11 - Data Reduction
   summary: ""
   description: |
    Returns/sets the angle range focus filter settings.

     This function requires at least user level: Authorized Client.
   operationId: Post/angleRangeFocusFilter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          angleRangeFocusFilter:
           type: object
           properties: 
            enable:
             type: boolean
             default: False
            thetaStart:
             type: integer
             minimum: -1800000
             maximum: 1800000
             default: -900000
            thetaStop:
             type: integer
             minimum: -1800000
             maximum: 1800000
             default: 900000
            phiStart:
             type: integer
             minimum: -900000
             maximum: 900000
             default: -250000
            phiStop:
             type: integer
             minimum: -900000
             maximum: 900000
             default: 250000
            thetaIndexIncrement:
             type: integer
             minimum: 1
             maximum: 50
             default: 1
            phiIndexIncrement:
             type: integer
             minimum: 1
             maximum: 50
             default: 1
            focusRegion:
             type: object
             properties: 
              enable:
               type: boolean
               default: False
              direction:
               type: integer
               default: 0
               enum: 
               - 0
               - 1
               description: >
                Mapping:
                 * 0 - HORIZONTAL
                 * 1 - VERTICAL
              thetaStart:
               type: integer
               minimum: -1800000
               maximum: 1800000
               default: -450000
              thetaStop:
               type: integer
               minimum: -1800000
               maximum: 1800000
               default: 450000
              phiStart:
               type: integer
               minimum: -900000
               maximum: 900000
               default: -100000
              phiStop:
               type: integer
               minimum: -900000
               maximum: 900000
               default: 100000
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /compactTelegramType6Content:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Return/sets the optional channels in the scan data compact telegram type 6 (muls270 specific compact format.).'
   operationId: Get/compactTelegramType6Content
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           includeRssi:
            type: boolean
            default: True
           includeProperties:
            type: boolean
            default: False
           includeAmbientLight:
            type: boolean
            default: True
           reserved:
            type: boolean
            default: False
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Return/sets the optional channels in the scan data compact telegram type 6 (muls270 specific compact format.).

     This function requires at least user level: Authorized Client.
   operationId: Post/compactTelegramType6Content
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          compactTelegramType6Content:
           type: object
           properties: 
            includeRssi:
             type: boolean
             default: True
            includeProperties:
             type: boolean
             default: False
            includeAmbientLight:
             type: boolean
             default: True
            reserved:
             type: boolean
             default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /SensorPosition:
  get: 
   tags: 
   - 7 - Mounting Position
   summary: ""
   description: 'Returns/sets the mounting position.'
   operationId: Get/SensorPosition
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           x:
            type: integer
            minimum: -100000
            maximum: 100000
            default: 0
           y:
            type: integer
            minimum: -100000
            maximum: 100000
            default: 0
           z:
            type: integer
            minimum: -100000
            maximum: 100000
            default: 0
           yaw:
            type: integer
            minimum: -3600000
            maximum: 3600000
            default: 0
           pitch:
            type: integer
            minimum: -3600000
            maximum: 3600000
            default: 0
           roll:
            type: integer
            minimum: -3600000
            maximum: 3600000
            default: 0
  post: 
   tags: 
   - 7 - Mounting Position
   summary: ""
   description: |
    Returns/sets the mounting position.

     This function requires at least user level: Authorized Client.
   operationId: Post/SensorPosition
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          SensorPosition:
           type: object
           properties: 
            x:
             type: integer
             minimum: -100000
             maximum: 100000
             default: 0
            y:
             type: integer
             minimum: -100000
             maximum: 100000
             default: 0
            z:
             type: integer
             minimum: -100000
             maximum: 100000
             default: 0
            yaw:
             type: integer
             minimum: -3600000
             maximum: 3600000
             default: 0
            pitch:
             type: integer
             minimum: -3600000
             maximum: 3600000
             default: 0
            roll:
             type: integer
             minimum: -3600000
             maximum: 3600000
             default: 0
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /rosFrameId:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the frame ID of the published topics.'
   operationId: Get/rosFrameId
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            rosFrameId:
             type: string
             default: "multiScan200_"
             maxLength: 64
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the frame ID of the published topics.

     This function requires at least user level: Authorized Client.
   operationId: Post/rosFrameId
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          rosFrameId:
           type: string
           default: "multiScan200_"
           maxLength: 64
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /rosParentFrameId:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the parent frame ID of the published topics.'
   operationId: Get/rosParentFrameId
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            rosParentFrameId:
             type: string
             default: "world"
             maxLength: 64
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the parent frame ID of the published topics.

     This function requires at least user level: Authorized Client.
   operationId: Post/rosParentFrameId
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          rosParentFrameId:
           type: string
           default: "world"
           maxLength: 64
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /rosPointCloud2Content:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the content of the published PointCloud2 topics.'
   operationId: Get/rosPointCloud2Content
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           includeRssi:
            type: boolean
            default: False
           includeProperties:
            type: boolean
            default: False
           includeTimeOffset:
            type: boolean
            default: False
           includeRing:
            type: boolean
            default: False
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the content of the published PointCloud2 topics.

     This function requires at least user level: Authorized Client.
   operationId: Post/rosPointCloud2Content
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          rosPointCloud2Content:
           type: object
           properties: 
            includeRssi:
             type: boolean
             default: False
            includeProperties:
             type: boolean
             default: False
            includeTimeOffset:
             type: boolean
             default: False
            includeRing:
             type: boolean
             default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /rosNamespace:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the namespace of the published topics.'
   operationId: Get/rosNamespace
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            rosNamespace:
             type: string
             default: " "
             maxLength: 64
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the namespace of the published topics.

     This function requires at least user level: Authorized Client.
   operationId: Post/rosNamespace
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          rosNamespace:
           type: string
           default: " "
           maxLength: 64
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /rosDomainId:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns/sets the ros domain ID.'
   operationId: Get/rosDomainId
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            rosDomainId:
             type: integer
             maximum: 232
             default: 0
  post: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: |
    Returns/sets the ros domain ID.

     This function requires at least user level: Authorized Client.
   operationId: Post/rosDomainId
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          rosDomainId:
           type: integer
           maximum: 232
           default: 0
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /mStartMeasure:
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Starts motor and measurement.

     This function requires at least user level: Authorized Client.
   operationId: Post/mStartMeasure
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /mStandby:
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Disables the Laser.

     This function requires at least user level: Authorized Client.
   operationId: Post/mStandby
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /mStopMeasure:
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Stops motor and measurement.

     This function requires at least user level: Authorized Client.
   operationId: Post/mStopMeasure
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /AutoStartMeasure:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the mode for automatic start of measurement after boot-up.'
   operationId: Get/AutoStartMeasure
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            AutoStartMeasure:
             type: boolean
             default: True
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the mode for automatic start of measurement after boot-up.

     This function requires at least user level: Authorized Client.
   operationId: Post/AutoStartMeasure
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          AutoStartMeasure:
           type: boolean
           default: True
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /InertialMeasurementUnit:
  get: 
   tags: 
   - 10 - Measurement Data Output
   summary: ""
   description: 'Returns the current IMU data (e.g. Acceleration, Orientation, ... ). The data is given in the following coordinate system which is based on the DIN70000 system. The x-axis lies on the 90-degree-beam of the 0-degree-layer. The y-axis is perpendicular to the x-axis and lies in the 0-degree-layer. The y-values are rising in the counterclockwise rotation direction (right-handed system). The z-axis is perpendicular to the x-y-plane and the scanner top points to rising z-values.'
   operationId: Get/InertialMeasurementUnit
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Acceleration:
            type: array
            maxItems: 3
            minItems: 0
            default: []
            items: 
             type: number
             default: 0.0
           AngularVelocity:
            type: array
            maxItems: 3
            minItems: 0
            default: []
            items: 
             type: number
             default: 0.0
           Orientation:
            type: array
            maxItems: 4
            minItems: 0
            default: []
            items: 
             type: number
             default: 0.0
           TimeStamp:
            type: integer
 /PortConfiguration:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns/sets the port configuration of all I/Os.'
   operationId: Get/PortConfiguration
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            PortConfiguration:
             type: array
             maxItems: 8
             minItems: 8
             items: 
              type: object
              properties: 
               PortType:
                type: integer
                default: 0
                enum: 
                - 0
                - 1
                - 2
                description: >
                 Mapping:
                  * 0 - INPUT
                  * 1 - OUTPUT
                  * 2 - ENCODER
               Name:
                type: string
                default: "IOx"
                maxLength: 20
               InputSettings:
                type: object
                properties: 
                 Logic:
                  $ref: '#/components/schemas/Logic_t'
                 Debounce:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 10
                 Sensitivity:
                  type: integer
                  default: 0
                  enum: 
                  - 0
                  - 1
                  description: >
                   Mapping:
                    * 0 - EDGE
                    * 1 - LEVEL
                 Reserved1:
                  type: integer
                  default: 0
                 Reserved2:
                  type: integer
                  default: 0
               OutputSettings:
                type: object
                properties: 
                 Logic:
                  $ref: '#/components/schemas/Logic_t'
                 OutputMode:
                  type: integer
                  default: 0
                  enum: 
                  - 0
                  - 1
                  - 2
                  description: >
                   Mapping:
                    * 0 - PNP
                    * 1 - NPN
                    * 2 - PUSH_PULL
                 RestartType:
                  type: integer
                  default: 0
                  enum: 
                  - 0
                  - 1
                  - 2
                  description: >
                   Mapping:
                    * 0 - RESTART_IMMEDATE
                    * 1 - RESTART_TIME
                    * 2 - RESTART_INPUT
                 RestartTime:
                  type: integer
                  minimum: 20
                  maximum: 600000
                  default: 200
                 RestartInput:
                  type: integer
                  minimum: 1
                  maximum: 8
                  default: 1
                 Combination:
                  type: integer
                  default: 1
                  enum: 
                  - 0
                  - 1
                  - 2
                  description: >
                   Mapping:
                    * 0 - AND
                    * 1 - OR
                    * 2 - XOR
                 Reserved3:
                  type: integer
                  default: 0
                 Reserved4:
                  type: integer
                  default: 0
                 Sources:
                  type: array
                  maxItems: 128
                  minItems: 0
                  default: []
                  items: 
                   type: object
                   properties: 
                    Name:
                     type: string
                     default: "    "
                     maxLength: 4
                     minLength: 4
                    Invert:
                     type: boolean
                     default: False
                    Reserved5:
                     type: integer
                     default: 0
                    Reserved6:
                     type: integer
                     default: 0
               EncoderPortType:
                type: integer
                default: 0
                enum: 
                - 0
                - 1
                - 2
                - 3
                - 4
                description: >
                 Mapping:
                  * 0 - NONE
                  * 1 - ENCODER_A
                  * 2 - ENCODER_B
                  * 3 - AUX1
                  * 4 - AUX2
               Reserved8:
                type: integer
                default: 0
               Reserved9:
                type: integer
                default: 0
               Reserved10:
                type: integer
                default: 0
  post: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: |
    Returns/sets the port configuration of all I/Os.

     This function requires at least user level: Authorized Client.
   operationId: Post/PortConfiguration
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          PortConfiguration:
           type: array
           maxItems: 8
           minItems: 8
           items: 
            type: object
            properties: 
             PortType:
              type: integer
              default: 0
              enum: 
              - 0
              - 1
              - 2
              description: >
               Mapping:
                * 0 - INPUT
                * 1 - OUTPUT
                * 2 - ENCODER
             Name:
              type: string
              default: "IOx"
              maxLength: 20
             InputSettings:
              type: object
              properties: 
               Logic:
                $ref: '#/components/schemas/Logic_t'
               Debounce:
                type: integer
                minimum: 1
                maximum: 1000
                default: 10
               Sensitivity:
                type: integer
                default: 0
                enum: 
                - 0
                - 1
                description: >
                 Mapping:
                  * 0 - EDGE
                  * 1 - LEVEL
               Reserved1:
                type: integer
                default: 0
               Reserved2:
                type: integer
                default: 0
             OutputSettings:
              type: object
              properties: 
               Logic:
                $ref: '#/components/schemas/Logic_t'
               OutputMode:
                type: integer
                default: 0
                enum: 
                - 0
                - 1
                - 2
                description: >
                 Mapping:
                  * 0 - PNP
                  * 1 - NPN
                  * 2 - PUSH_PULL
               RestartType:
                type: integer
                default: 0
                enum: 
                - 0
                - 1
                - 2
                description: >
                 Mapping:
                  * 0 - RESTART_IMMEDATE
                  * 1 - RESTART_TIME
                  * 2 - RESTART_INPUT
               RestartTime:
                type: integer
                minimum: 20
                maximum: 600000
                default: 200
               RestartInput:
                type: integer
                minimum: 1
                maximum: 8
                default: 1
               Combination:
                type: integer
                default: 1
                enum: 
                - 0
                - 1
                - 2
                description: >
                 Mapping:
                  * 0 - AND
                  * 1 - OR
                  * 2 - XOR
               Reserved3:
                type: integer
                default: 0
               Reserved4:
                type: integer
                default: 0
               Sources:
                type: array
                maxItems: 128
                minItems: 0
                default: []
                items: 
                 type: object
                 properties: 
                  Name:
                   type: string
                   default: "    "
                   maxLength: 4
                   minLength: 4
                  Invert:
                   type: boolean
                   default: False
                  Reserved5:
                   type: integer
                   default: 0
                  Reserved6:
                   type: integer
                   default: 0
             EncoderPortType:
              type: integer
              default: 0
              enum: 
              - 0
              - 1
              - 2
              - 3
              - 4
              description: >
               Mapping:
                * 0 - NONE
                * 1 - ENCODER_A
                * 2 - ENCODER_B
                * 3 - AUX1
                * 4 - AUX2
             Reserved8:
              type: integer
              default: 0
             Reserved9:
              type: integer
              default: 0
             Reserved10:
              type: integer
              default: 0
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /SetOutput:
  post: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Sets the output state for an individual output. Precondition is to set the output source to "SOPAS command".'
   operationId: Post/SetOutput
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          Output:
           type: integer
          Value:
           type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           Success:
            type: boolean
            default: false
 /InputState:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns the state of all inputs.'
   operationId: Get/InputState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           uiVersionNumber:
            type: integer
            default: 1
           udiSystCount:
            type: integer
           aDigitalIn:
            type: array
            maxItems: 8
            minItems: 8
            items: 
             type: object
             properties: 
              IOState:
               $ref: '#/components/schemas/IOState_t'
           aTimeBlock:
            type: array
            maxItems: 1
            minItems: 0
            default: []
            items: 
             $ref: '#/components/schemas/DateTime_t'
 /OutputState:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns the state of all outputs.'
   operationId: Get/OutputState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           uiVersionNumber:
            type: integer
            default: 1
           udiSystCount:
            type: integer
           aDigitalOut:
            type: array
            maxItems: 8
            minItems: 8
            items: 
             type: object
             properties: 
              IOState:
               $ref: '#/components/schemas/IOState_t'
              udiCounter:
               type: integer
           aTimeBlock:
            type: array
            maxItems: 1
            minItems: 0
            default: []
            items: 
             $ref: '#/components/schemas/DateTime_t'
 /PortState:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns the state of the ports. "PortState" is preferred over "OutputState".'
   operationId: Get/PortState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           uiVersionNumber:
            type: integer
           udiSystCount:
            type: integer
           aInternalPorts:
            type: array
            maxItems: 8
            minItems: 0
            default: []
            items: 
             $ref: '#/components/schemas/PortStateAndCounter_t'
           aExternalPorts:
            type: array
            maxItems: 8
            minItems: 0
            default: []
            items: 
             $ref: '#/components/schemas/PortStateAndCounter_t'
           aTimeBlock:
            type: array
            maxItems: 1
            minItems: 0
            default: []
            items: 
             $ref: '#/components/schemas/DateTime_t'
 /mResetOutputCounter:
  post: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: |
    Resets the counter for the outputs.

     This function requires at least user level: Authorized Client.
   operationId: Post/mResetOutputCounter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /LEDState:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns the LED status.'
   operationId: Get/LEDState
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LEDState:
             type: array
             maxItems: 8
             minItems: 0
             default: []
             items: 
              $ref: '#/components/schemas/LedStateType'
 /LEDEnable:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the LED mode (on/off).'
   operationId: Get/LEDEnable
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LEDEnable:
             type: boolean
             default: True
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the LED mode (on/off).

     This function requires at least user level: Authorized Client.
   operationId: Post/LEDEnable
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          LEDEnable:
           type: boolean
           default: True
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /FindMe:
  post: 
   tags: 
   - 3 - Device Information
   summary: ""
   description: 'Sets the device LEDs into blinking mode for better identification.'
   operationId: Post/FindMe
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        data:
         type: object
         properties: 
          uiDuration:
           type: integer
           minimum: 1
         example:
          uiDuration: 100
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LFTchecksum:
  get: 
   tags: 
   - 1 - General
   summary: ""
   description: 'Returns a checksum over all software parts and configurations.'
   operationId: Get/LFTchecksum
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           MD5SumOK:
            type: boolean
            default: False
           MD5LinuxRoot:
            type: string
            default: " "
            maxLength: 32
           MD5App:
            type: string
            default: " "
            maxLength: 32
           MD5Calibration:
            type: string
            default: " "
            maxLength: 32
           MD5Parameters:
            type: string
            default: " "
            maxLength: 32
 /ScanConfig:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns the configuration of angular resolution, scanning frequency and start angle.'
   operationId: Get/ScanConfig
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           udiScanFreq:
            type: integer
            minimum: 100
            maximum: 2000
            default: 2000
           ScanRange:
            type: object
            properties: 
             uiLength:
              type: integer
              minimum: 1
              maximum: 1
              default: 1
             aThetaAngleRange:
              type: array
              maxItems: 1
              minItems: 1
              items: 
               type: object
               properties: 
                udiThetaAngleRes:
                 type: integer
                 minimum: 100
                 maximum: 100000
                 default: 4700
                diThetaStartAngle:
                 type: integer
                 minimum: -1800000
                 maximum: 1800000
                 default: -1380000
                diThetaStopAngle:
                 type: integer
                 minimum: -1800000
                 maximum: 1800000
                 default: 1380000
             aPhiAngleRange:
              type: array
              maxItems: 1
              minItems: 1
              items: 
               type: object
               properties: 
                udiPhiAngleRes:
                 type: integer
                 minimum: 100
                 maximum: 100000
                 default: 4700
                diPhiStartAngle:
                 type: integer
                 minimum: -450000
                 maximum: 450000
                 default: -225000
                diPhiStopAngle:
                 type: integer
                 minimum: -450000
                 maximum: 450000
                 default: 225000
 /PerformanceProfileNumber:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns the scan configuration profile (scanning frequency and angular resolution).'
   operationId: Get/PerformanceProfileNumber
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            PerformanceProfileNumber:
             $ref: '#/components/schemas/PerformanceProfiles_t'
 /SetScanConfigList:
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Sets the scan configuration profile (field of view, scanning frequency and angular resolution).

     This function requires at least user level: Authorized Client.
   operationId: Post/SetScanConfigList
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          ScanConfigList:
           $ref: '#/components/schemas/PerformanceProfiles_t'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           eScanConfigError:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            description: >
             Mapping:
              * 0 - SCE_OK
              * 1 - SCE_ERROR_FREQ
              * 2 - SCE_ERROR_RES
              * 3 - SCE_ERROR_FREQ_RES_COMB
              * 4 - SCE_ERROR_NUM_RANGE
              * 5 - SCE_ERROR
              * 6 - SCE_ERROR_NO_LICENSE
 /horizontalFieldOfViewCenterAngle:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the horizontal field of view center angle.'
   operationId: Get/horizontalFieldOfViewCenterAngle
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            horizontalFieldOfViewCenterAngle:
             type: integer
             minimum: -1800000
             maximum: 1800000
             default: 0
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the horizontal field of view center angle.

     This function requires at least user level: Authorized Client.
   operationId: Post/horizontalFieldOfViewCenterAngle
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          horizontalFieldOfViewCenterAngle:
           type: integer
           minimum: -1800000
           maximum: 1800000
           default: 0
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /bloomingFilter:
  get: 
   tags: 
   - 6 - Filter
   summary: ""
   description: 'Returns/sets the blooming filter.'
   operationId: Get/bloomingFilter
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           strength:
            type: integer
            default: 1
            enum: 
            - 0
            - 1
            - 2
            description: >
             Mapping:
              * 0 - LOW
              * 1 - MEDIUM
              * 2 - STRONG
           enable:
            type: boolean
            default: False
  post: 
   tags: 
   - 6 - Filter
   summary: ""
   description: |
    Returns/sets the blooming filter.

     This function requires at least user level: Authorized Client.
   operationId: Post/bloomingFilter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          bloomingFilter:
           type: object
           properties: 
            strength:
             type: integer
             default: 1
             enum: 
             - 0
             - 1
             - 2
             description: >
              Mapping:
               * 0 - LOW
               * 1 - MEDIUM
               * 2 - STRONG
            enable:
             type: boolean
             default: False
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /particleFilter:
  get: 
   tags: 
   - 6 - Filter
   summary: ""
   description: 'Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snow, or similar.'
   operationId: Get/particleFilter
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           enable:
            type: boolean
            default: False
           minNumberOfNeighbors:
            type: integer
            maximum: 8
            default: 1
           distanceThreshold:
            type: integer
            minimum: 20
            maximum: 2000
            default: 500
  post: 
   tags: 
   - 6 - Filter
   summary: ""
   description: |
    Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snow, or similar.

     This function requires at least user level: Authorized Client.
   operationId: Post/particleFilter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          particleFilter:
           type: object
           properties: 
            enable:
             type: boolean
             default: False
            minNumberOfNeighbors:
             type: integer
             maximum: 8
             default: 1
            distanceThreshold:
             type: integer
             minimum: 20
             maximum: 2000
             default: 500
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /ambientPixelCountVertical:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the vertical ambient pixel count.'
   operationId: Get/ambientPixelCountVertical
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            ambientPixelCountVertical:
             type: integer
             default: 1
             enum: 
             - 0
             - 1
             description: >
              Mapping:
               * 0 - FULL
               * 1 - MATCHING
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the vertical ambient pixel count.

     This function requires at least user level: Authorized Client.
   operationId: Post/ambientPixelCountVertical
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          ambientPixelCountVertical:
           type: integer
           default: 1
           enum: 
           - 0
           - 1
           description: >
            Mapping:
             * 0 - FULL
             * 1 - MATCHING
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /SensitivityMode:
  get: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: 'Returns/sets the sensitivity of the receiver unit.'
   operationId: Get/SensitivityMode
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            SensitivityMode:
             type: integer
             default: 1
             enum: 
             - 0
             - 1
             - 2
             description: >
              Mapping:
               * 0 - MAXIMUM_ROBUSTNESS
               * 1 - STANDARD
               * 2 - MAXIMUM_DETECTIVITY
  post: 
   tags: 
   - 4 - Basic Settings
   summary: ""
   description: |
    Returns/sets the sensitivity of the receiver unit.

     This function requires at least user level: Authorized Client.
   operationId: Post/SensitivityMode
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          SensitivityMode:
           type: integer
           default: 1
           enum: 
           - 0
           - 1
           - 2
           description: >
            Mapping:
             * 0 - MAXIMUM_ROBUSTNESS
             * 1 - STANDARD
             * 2 - MAXIMUM_DETECTIVITY
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /FREchoFilter:
  get: 
   tags: 
   - 6 - Filter
   summary: ""
   description: 'Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo).'
   operationId: Get/FREchoFilter
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            FREchoFilter:
             type: integer
             default: 2
             enum: 
             - 0
             - 1
             - 2
             - 3
             - 4
             description: >
              Mapping:
               * 0 - FIRST_ECHO
               * 1 - ALL_ECHOS
               * 2 - LAST_ECHO
               * 3 - STRONGEST_ECHO
               * 4 - ALL_ECHOS_STRONGEST_FIRST
  post: 
   tags: 
   - 6 - Filter
   summary: ""
   description: |
    Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo).

     This function requires at least user level: Authorized Client.
   operationId: Post/FREchoFilter
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          FREchoFilter:
           type: integer
           default: 2
           enum: 
           - 0
           - 1
           - 2
           - 3
           - 4
           description: >
            Mapping:
             * 0 - FIRST_ECHO
             * 1 - ALL_ECHOS
             * 2 - LAST_ECHO
             * 3 - STRONGEST_ECHO
             * 4 - ALL_ECHOS_STRONGEST_FIRST
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /temperatureAlarmConfiguration:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns/sets temperature alarm thresholds.'
   operationId: Get/temperatureAlarmConfiguration
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           upperThreshold:
            type: integer
            default: 55
           lowerThreshold:
            type: integer
            default: 50
 /temperatureAlarmStatus:
  get: 
   tags: 
   - 9 - Inputs and Outputs
   summary: ""
   description: 'Returns the current temperature alarm status.'
   operationId: Get/temperatureAlarmStatus
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            temperatureAlarmStatus:
             type: boolean
             default: False
 /CurrentTempDev:
  get: 
   tags: 
   - 12 - Operating Data
   summary: ""
   description: 'Returns the current device temperature.'
   operationId: Get/CurrentTempDev
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            CurrentTempDev:
             type: number
             default: 20.0
 /TSCRole:
  get: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: 'Returns/sets the time synchronization role (none, NTP or PTP).'
   operationId: Get/TSCRole
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            TSCRole:
             type: integer
             default: 0
             enum: 
             - 0
             - 1
             - 3
             description: >
              Mapping:
               * 0 - TX_NONE
               * 1 - TX_CLIENT
               * 3 - TX_PTP_SLAVE
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Returns/sets the time synchronization role (none, NTP or PTP).

     This function requires at least user level: Authorized Client.
   operationId: Post/TSCRole
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          TSCRole:
           type: integer
           default: 0
           enum: 
           - 0
           - 1
           - 3
           description: >
            Mapping:
             * 0 - TX_NONE
             * 1 - TX_CLIENT
             * 3 - TX_PTP_SLAVE
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /TSCTCSrvAddr:
  get: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: 'Returns/sets the IP address of the time server.'
   operationId: Get/TSCTCSrvAddr
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            TSCTCSrvAddr:
             type: array
             maxItems: 4
             minItems: 0
             default: [192,168,0,11]
             items: 
              type: integer
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Returns/sets the IP address of the time server.

     This function requires at least user level: Authorized Client.
   operationId: Post/TSCTCSrvAddr
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          TSCTCSrvAddr:
           type: array
           maxItems: 4
           minItems: 0
           default: [192,168,0,11]
           items: 
            type: integer
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /TSCTCtimezone:
  get: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: 'Returns/sets the time zone of the device.'
   operationId: Get/TSCTCtimezone
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            TSCTCtimezone:
             type: integer
             default: 36
             enum: 
             - 0
             - 1
             - 2
             - 3
             - 4
             - 5
             - 6
             - 7
             - 8
             - 9
             - 10
             - 11
             - 12
             - 13
             - 14
             - 15
             - 16
             - 17
             - 18
             - 19
             - 20
             - 21
             - 22
             - 23
             - 24
             - 25
             - 26
             - 27
             - 28
             - 29
             - 30
             - 31
             - 32
             - 33
             - 34
             - 35
             - 36
             - 37
             - 38
             - 39
             - 40
             - 41
             - 42
             - 43
             - 44
             - 45
             - 46
             - 47
             - 48
             - 49
             - 50
             - 51
             - 52
             - 53
             - 54
             - 55
             - 56
             - 57
             - 58
             - 59
             - 60
             - 61
             - 62
             - 63
             - 64
             - 65
             - 66
             - 67
             - 68
             - 69
             - 70
             - 71
             - 72
             - 73
             - 74
             - 75
             - 76
             - 77
             - 78
             - 79
             - 80
             - 81
             - 82
             - 83
             - 84
             - 85
             - 86
             - 87
             - 88
             - 89
             - 90
             - 91
             - 92
             - 93
             - 94
             - 95
             - 96
             - 97
             - 98
             - 99
             - 100
             - 101
             - 102
             - 103
             - 104
             description: >
              Mapping:
               * 0 - DATE_LINE_STANDARD
               * 1 - COORD_WORLD_TIME_11
               * 2 - HAWAII
               * 3 - ALASKA
               * 4 - CALIFORNIA
               * 5 - USA_CANADA
               * 6 - ARIZONA
               * 7 - LA_PAZ
               * 8 - MOUNTAIN_TIME_USA
               * 9 - CENTRAL_TIME_USA
               * 10 - MEXICO_CITY
               * 11 - MIDDLE_AMERICA
               * 12 - SASKATCHEWAN
               * 13 - BOGOTA_LIMA
               * 14 - EASTERN_TIME_USA
               * 15 - INDIANA
               * 16 - CARACAS
               * 17 - ASUNCION
               * 18 - ATLANTIC_KANADA
               * 19 - CUIABA
               * 20 - LAPAZ_SANJUAN
               * 21 - SANTIAGO
               * 22 - NEUFUNDLAND
               * 23 - BRASILIA
               * 24 - BUENOS_AIRES
               * 25 - CAYENNE_FORTALEZA
               * 26 - GROENLAND
               * 27 - MONTEVIDEO
               * 28 - SALVADOR
               * 29 - COORD_WORLD_TIME_02
               * 30 - AZOREN
               * 31 - KAP_VERDE
               * 32 - CASABLANCA
               * 33 - DUBLIN_LISSABON_LONDON
               * 34 - COORD_WORLD_TIME
               * 35 - MONROVIA_REYKJAVIK
               * 36 - AMSTERDAM_BERLIN_ROM
               * 37 - BELGRAD_BUDAPEST_PRAG
               * 38 - BRUESSEL_MADRID_PARIS
               * 39 - SARAJEVO_WARSCHAU
               * 40 - WEST_CENTRAL_AFRICA
               * 41 - WINDHUK
               * 42 - JOHANNESBURG
               * 43 - AMMAN
               * 44 - ATHEN_BUKAREST
               * 45 - BEIRUT
               * 46 - DAMASCUS
               * 47 - HARARE_PRETORIA
               * 48 - HELSINKI_KIEW_RIGA
               * 49 - ISTANBUL
               * 50 - JERUSALEM
               * 51 - KAIRO
               * 52 - KALININGRAD
               * 53 - TRIPOLIS
               * 54 - BAGDAD
               * 55 - KUWAIT_RIAD
               * 56 - MINSK
               * 57 - MOSKAU_PETERSBURG
               * 58 - NAIROBI
               * 59 - TEHERAN
               * 60 - ABU_DHABI
               * 61 - BAKU
               * 62 - ERIWAN
               * 63 - ISCHEWSK_SAMARA
               * 64 - PORT_LOUIS
               * 65 - TIFLIS
               * 66 - KABUL
               * 67 - ASCHGABET_TASCHKENT
               * 68 - ISLAMABAD_KARATSCHI
               * 69 - JEKATERINBURG
               * 70 - MUMBAI_NEUDELHI
               * 71 - SRI_JAYAWARDENEPURA
               * 72 - KATMANDU
               * 73 - ASTANA
               * 74 - DAKKA
               * 75 - NOWOSIBIRSK
               * 76 - YANGON
               * 77 - BANGKOK_HANOI_JAKARTA
               * 78 - KRASNOJARSK
               * 79 - IRKUTSK
               * 80 - KUALA_LUMPUR_SINGAPUR
               * 81 - PEKING_HONGKONG
               * 82 - PERTH
               * 83 - TAIPEH
               * 84 - ULAN_BATOR
               * 85 - JAKUTSK
               * 86 - OSAKA_TOKIO
               * 87 - SEOUL
               * 88 - ADELAIDE
               * 89 - DARWIN
               * 90 - BRISBANE
               * 91 - CANBERRA_SYDNEY
               * 92 - GUAM_PORT_MORESBY
               * 93 - HOBART
               * 94 - MAGADAN
               * 95 - WLADIWOSTOK
               * 96 - SALOMONEN_KALEDONIEN
               * 97 - TSCHOKURDACH
               * 98 - ANADYR
               * 99 - AUCKLAND_WELLINGTON
               * 100 - FIDSCHI
               * 101 - COORD_WORLD_TIME_12
               * 102 - NAKUALOFA
               * 103 - SAMOA
               * 104 - KIRITIMATI
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Returns/sets the time zone of the device.

     This function requires at least user level: Authorized Client.
   operationId: Post/TSCTCtimezone
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          TSCTCtimezone:
           type: integer
           default: 36
           enum: 
           - 0
           - 1
           - 2
           - 3
           - 4
           - 5
           - 6
           - 7
           - 8
           - 9
           - 10
           - 11
           - 12
           - 13
           - 14
           - 15
           - 16
           - 17
           - 18
           - 19
           - 20
           - 21
           - 22
           - 23
           - 24
           - 25
           - 26
           - 27
           - 28
           - 29
           - 30
           - 31
           - 32
           - 33
           - 34
           - 35
           - 36
           - 37
           - 38
           - 39
           - 40
           - 41
           - 42
           - 43
           - 44
           - 45
           - 46
           - 47
           - 48
           - 49
           - 50
           - 51
           - 52
           - 53
           - 54
           - 55
           - 56
           - 57
           - 58
           - 59
           - 60
           - 61
           - 62
           - 63
           - 64
           - 65
           - 66
           - 67
           - 68
           - 69
           - 70
           - 71
           - 72
           - 73
           - 74
           - 75
           - 76
           - 77
           - 78
           - 79
           - 80
           - 81
           - 82
           - 83
           - 84
           - 85
           - 86
           - 87
           - 88
           - 89
           - 90
           - 91
           - 92
           - 93
           - 94
           - 95
           - 96
           - 97
           - 98
           - 99
           - 100
           - 101
           - 102
           - 103
           - 104
           description: >
            Mapping:
             * 0 - DATE_LINE_STANDARD
             * 1 - COORD_WORLD_TIME_11
             * 2 - HAWAII
             * 3 - ALASKA
             * 4 - CALIFORNIA
             * 5 - USA_CANADA
             * 6 - ARIZONA
             * 7 - LA_PAZ
             * 8 - MOUNTAIN_TIME_USA
             * 9 - CENTRAL_TIME_USA
             * 10 - MEXICO_CITY
             * 11 - MIDDLE_AMERICA
             * 12 - SASKATCHEWAN
             * 13 - BOGOTA_LIMA
             * 14 - EASTERN_TIME_USA
             * 15 - INDIANA
             * 16 - CARACAS
             * 17 - ASUNCION
             * 18 - ATLANTIC_KANADA
             * 19 - CUIABA
             * 20 - LAPAZ_SANJUAN
             * 21 - SANTIAGO
             * 22 - NEUFUNDLAND
             * 23 - BRASILIA
             * 24 - BUENOS_AIRES
             * 25 - CAYENNE_FORTALEZA
             * 26 - GROENLAND
             * 27 - MONTEVIDEO
             * 28 - SALVADOR
             * 29 - COORD_WORLD_TIME_02
             * 30 - AZOREN
             * 31 - KAP_VERDE
             * 32 - CASABLANCA
             * 33 - DUBLIN_LISSABON_LONDON
             * 34 - COORD_WORLD_TIME
             * 35 - MONROVIA_REYKJAVIK
             * 36 - AMSTERDAM_BERLIN_ROM
             * 37 - BELGRAD_BUDAPEST_PRAG
             * 38 - BRUESSEL_MADRID_PARIS
             * 39 - SARAJEVO_WARSCHAU
             * 40 - WEST_CENTRAL_AFRICA
             * 41 - WINDHUK
             * 42 - JOHANNESBURG
             * 43 - AMMAN
             * 44 - ATHEN_BUKAREST
             * 45 - BEIRUT
             * 46 - DAMASCUS
             * 47 - HARARE_PRETORIA
             * 48 - HELSINKI_KIEW_RIGA
             * 49 - ISTANBUL
             * 50 - JERUSALEM
             * 51 - KAIRO
             * 52 - KALININGRAD
             * 53 - TRIPOLIS
             * 54 - BAGDAD
             * 55 - KUWAIT_RIAD
             * 56 - MINSK
             * 57 - MOSKAU_PETERSBURG
             * 58 - NAIROBI
             * 59 - TEHERAN
             * 60 - ABU_DHABI
             * 61 - BAKU
             * 62 - ERIWAN
             * 63 - ISCHEWSK_SAMARA
             * 64 - PORT_LOUIS
             * 65 - TIFLIS
             * 66 - KABUL
             * 67 - ASCHGABET_TASCHKENT
             * 68 - ISLAMABAD_KARATSCHI
             * 69 - JEKATERINBURG
             * 70 - MUMBAI_NEUDELHI
             * 71 - SRI_JAYAWARDENEPURA
             * 72 - KATMANDU
             * 73 - ASTANA
             * 74 - DAKKA
             * 75 - NOWOSIBIRSK
             * 76 - YANGON
             * 77 - BANGKOK_HANOI_JAKARTA
             * 78 - KRASNOJARSK
             * 79 - IRKUTSK
             * 80 - KUALA_LUMPUR_SINGAPUR
             * 81 - PEKING_HONGKONG
             * 82 - PERTH
             * 83 - TAIPEH
             * 84 - ULAN_BATOR
             * 85 - JAKUTSK
             * 86 - OSAKA_TOKIO
             * 87 - SEOUL
             * 88 - ADELAIDE
             * 89 - DARWIN
             * 90 - BRISBANE
             * 91 - CANBERRA_SYDNEY
             * 92 - GUAM_PORT_MORESBY
             * 93 - HOBART
             * 94 - MAGADAN
             * 95 - WLADIWOSTOK
             * 96 - SALOMONEN_KALEDONIEN
             * 97 - TSCHOKURDACH
             * 98 - ANADYR
             * 99 - AUCKLAND_WELLINGTON
             * 100 - FIDSCHI
             * 101 - COORD_WORLD_TIME_12
             * 102 - NAKUALOFA
             * 103 - SAMOA
             * 104 - KIRITIMATI
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /TSCTCupdatetime:
  get: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: 'Returns/sets the update time of the client.'
   operationId: Get/TSCTCupdatetime
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            TSCTCupdatetime:
             type: integer
             minimum: 1
             maximum: 3600
             default: 600
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Returns/sets the update time of the client.

     This function requires at least user level: Authorized Client.
   operationId: Post/TSCTCupdatetime
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          TSCTCupdatetime:
           type: integer
           minimum: 1
           maximum: 3600
           default: 600
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
 /LSPdatetime:
  get: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: 'Returns the current time of the device (years, months, days, hours, minutes, seconds, microseconds).'
   operationId: Get/LSPdatetime
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
           type: object
           properties: 
            LSPdatetime:
             $ref: '#/components/schemas/DateTime_t'
 /LSPsetdatetime:
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Sets the current time of the device in local time by using the time zone as defined in TSCTCtimezone (years, months, days, hours, minutes, seconds, microseconds). Does only work if NTP-Client and PTP is not active.

     This function requires at least user level: Authorized Client.
   operationId: Post/LSPsetdatetime
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          DateTime:
           $ref: '#/components/schemas/DateTime_t'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /setDateTimeUTC:
  post: 
   tags: 
   - 5 - Date and System Time
   summary: ""
   description: |
    Preferred method to sets the current time of device in UTC (years, months, days, hours, minutes, seconds, microseconds). Does only work if NTP-Client and PTP is not active.

     This function requires at least user level: Authorized Client.
   operationId: Post/setDateTimeUTC
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       properties: 
        header:
         $ref: '#/components/schemas/PostBodyHeader'
        data:
         type: object
         properties: 
          DateTime:
           $ref: '#/components/schemas/DateTime_t'
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           ErrorCode:
            type: integer
            default: 0
            enum: 
            - 0
            - 1
            description: >
             Mapping:
              * 0 - SOPAS_ERR_NO_ERR
              * 1 - SOPAS_ERR_STATE_CHANGE_NOT_PERMITTED
 /CreateSessionToken:
  post: 
   tags: 
   - 1 - General
   summary: ""
   description: 'A short-lived session token to pass to a HTTP request header.'
   operationId: Post/CreateSessionToken
   requestBody:
    description: successful operation
    required: true
    content: 
     application/json: 
      schema: 
       type: object
       nullable: true
   responses: 
    '200':
     description: successful operation
     content: 
      application/json: 
       schema: 
        type: object
        required: ["header"]
        properties: 
         header:
          $ref: '#/components/schemas/ResponseHeader'
         data:
          type: object
          properties: 
           token:
            $ref: '#/components/schemas/SessionToken'
           timeToLive:
            type: integer
components: 
 schemas:
  ResponseHeader:
   type: object
   properties: 
    status:
     type: integer
     default: 0
     enum: 
     - 0
     - 1
     - 2
     - 3
     - 4
     - 5
     - 6
     - 7
     - 8
     - 9
     - 10
     - 11
     description: >
      Mapping:
       * 0 - Ok
       * 1 - Parsing Failed
       * 2 - Invalid Data
       * 3 - Internal Server Error
       * 4 - Access Denied
       * 5 - Not Found
       * 6 - Out Of Range
       * 7 - Out Of Bounds
       * 8 - Read Only
       * 9 - Illegal Value
       * 10 - Invalid Challenge
       * 11 - Out Of Connections
    message:
     type: string
     default: "Ok"
  PostBodyHeader:
   type: object
   properties: 
    nonce:
     type: string
     default: " "
    opaque:
     type: string
     default: " "
    realm:
     type: string
     default: "SICK Sensor"
    response:
     type: string
     default: " "
    user:
     type: string
     default: "AuthorizedClient"
  E_USER_LEVEL_TYPE:
   type: string
   default: Run
   enum: 
   - Run
   - Operator
   - Maintenance
   - AuthorizedClient
   - Service
  RestoreBackupResult:
   type: integer
   default: 0
   enum: 
   - 0
   - 1
   - 2
   - 3
   - 4
   - 5
   - 6
   - 7
   - 8
   - 9
   - 10
   - 50
   description: >
    Mapping:
     * 0 - Ok
     * 1 - ChecksumError
     * 2 - ParseError
     * 3 - DeviceIdentificationError
     * 4 - UpdateRepositoryError
     * 5 - UpdateSourceError
     * 6 - DecryptionError
     * 7 - DecryptionHeaderError
     * 8 - DecryptionLengthError
     * 9 - IoError
     * 10 - VersionConversionError
     * 50 - ComponentRegistryError
  DeviceStatus:
   type: integer
   default: 0
   enum: 
   - 0
   - 1
   - 2
   - 3
   - 4
   - 5
   - 6
   - 7
   - 8
   description: >
    Mapping:
     * 0 - DS_UnknownState
     * 1 - DS_Startup
     * 2 - DS_ServiceMode
     * 3 - DS_NormalOperation
     * 4 - DS_SuspendedOperation
     * 5 - DS_ServiceRecommended
     * 6 - DS_ServiceRequired
     * 7 - DS_RecoverableError
     * 8 - DS_FatalError
  httpsError_t:
   type: object
   properties: 
    error:
     type: string
     default: " "
     maxLength: 100
  Logic_t:
   type: integer
   default: 0
   enum: 
   - 0
   - 1
   description: >
    Mapping:
     * 0 - ACTIVE_HIGH
     * 1 - ACTIVE_LOW
  IOState_t:
   type: object
   properties: 
    eIOState:
     type: integer
     default: 2
     enum: 
     - 0
     - 1
     - 2
     description: >
      Mapping:
       * 0 - IOS_LOW
       * 1 - IOS_HIGH
       * 2 - IOS_TRISTATE
  PortStateAndCounter_t:
   type: object
   properties: 
    ePortState:
     type: integer
     default: 2
     enum: 
     - 0
     - 1
     - 2
     - 3
     - 4
     description: >
      Mapping:
       * 0 - OUTPUT_NOT_ACTIVE
       * 1 - OUTPUT_ACTIVE
       * 2 - TRISTATE
       * 3 - INPUT_ACTIVE
       * 4 - INPUT_NOT_ACTIVE
    PortCounter:
     type: integer
  DateTime_t:
   type: object
   properties: 
    uiYear:
     type: integer
     minimum: 0
     maximum: 2105
     default: 0
    usiMonth:
     type: integer
     minimum: 0
     maximum: 12
     default: 1
    usiDay:
     type: integer
     minimum: 0
     maximum: 31
     default: 1
    usiHour:
     type: integer
     minimum: 0
     maximum: 23
     default: 0
    usiMinute:
     type: integer
     minimum: 0
     maximum: 59
     default: 0
    usiSec:
     type: integer
     minimum: 0
     maximum: 59
     default: 0
    udiUSec:
     type: integer
     minimum: 0
     maximum: 999999
     default: 0
  LedStateType:
   type: object
   properties: 
    Color:
     type: integer
     default: 0
     enum: 
     - 0
     - 1
     - 2
     - 3
     description: >
      Mapping:
       * 0 - GREEN
       * 1 - YELLOW
       * 2 - RED
       * 3 - WHITE
    Function:
     type: integer
     default: 0
     enum: 
     - 0
     - 1
     - 2
     - 3
     - 4
     - 5
     - 6
     description: >
      Mapping:
       * 0 - ON
       * 1 - OFF
       * 2 - BLINKING
       * 3 - BLINKING_FAST
       * 4 - BLINKING_DELAYED
       * 5 - BLINKING_COLOR
       * 6 - BLINKING_YELLOW_RED
    Id:
     type: string
     default: " "
     maxLength: 8
  Evaluation_t:
   type: object
   properties: 
    Version:
     type: integer
     default: 1
    Source:
     type: integer
     default: 0
     enum: 
     - 0
     - 1
     - 2
     description: >
      Mapping:
       * 0 - STANDARD
       * 1 - HIGHRES_6
       * 2 - HIGHRES_14
    Name:
     type: string
     default: " "
     maxLength: 20
    ID:
     type: integer
     default: 1
    EvaluationParamsMaskBased:
     type: array
     maxItems: 1
     minItems: 0
     items: 
      type: object
      properties: 
       InfringementThresholdFactor:
        type: integer
        minimum: 1
        maximum: 100
        default: 80
    EvaluationParamsSegmentationBased:
     type: array
     maxItems: 1
     minItems: 0
     items: 
      type: object
      properties: 
       SampleParam1:
        type: integer
    EvaluationParamsCommon:
     type: array
     maxItems: 1
     minItems: 0
     items: 
      type: object
      properties: 
       MinimumObjectSizeHorizontal:
        type: integer
        minimum: 0
        maximum: 5000
        default: 200
       MinimumObjectSizeVertical:
        type: integer
        minimum: 0
        maximum: 5000
        default: 200
       OcclusionHandling:
        type: boolean
        default: False
       TreatMissingDataAsInfringed:
        type: boolean
        default: False
       TimeForInfringedState:
        type: integer
        minimum: 1
        maximum: 10000
        default: 300
       TimeForFreeState:
        type: integer
        minimum: 1
        maximum: 10000
        default: 50
       Reserved3:
        type: integer
       Reserved4:
        type: integer
    EvaluationParamsExitSize:
     type: array
     maxItems: 1
     minItems: 0
     items: 
      type: object
      properties: 
       disableExitSize:
        type: boolean
        default: False
       exitSizeVertical:
        type: integer
        minimum: 0
        maximum: 100
        default: 70
       exitSizeHorizontal:
        type: integer
        minimum: 0
        maximum: 100
        default: 100
    VolumeList:
     type: array
     maxItems: 1
     minItems: 0
     default: []
     items: 
      type: integer
      minimum: 1
      maximum: 48
      default: 1
  EvaluationResult_t:
   type: object
   properties: 
    State:
     type: integer
     default: 0
     enum: 
     - 0
     - 1
     - 2
     - 3
     - 4
     - 5
     description: >
      Mapping:
       * 0 - NOT_CONFIGURED
       * 1 - INACTIVE
       * 2 - FREE
       * 3 - DETECTING_INFRINGED
       * 4 - INFRINGED
       * 5 - DETECTING_FREE
  FieldEvaluationResult_t:
   type: object
   properties: 
    Version:
     type: integer
     default: 1
    Timestamp:
     type: integer
    EvaluationResultList:
     type: array
     maxItems: 48
     minItems: 0
     default: []
     items: 
      $ref: '#/components/schemas/EvaluationResult_t'
  PerformanceProfiles_t:
   type: integer
   default: 1
   enum: 
   - 1
   - 2
   - 3
   - 4
   - 10
   - 11
   - 12
   - 20
   - 21
   description: >
    Mapping:
     * 1 - SC_047h_047v_276_20Hz_1x
     * 2 - SC_047h_094v_276_20Hz_1x
     * 3 - SC_047h_023v_276_20Hz_1x
     * 4 - SC_047h_047v_360_10Hz_1x
     * 10 - SC_023h_047v_276_20Hz_2x
     * 11 - SC_023h_023v_276_20Hz_2x
     * 12 - SC_012h_023v_276_20Hz_4x
     * 20 - SC_047h_047v_190_20Hz_1x
     * 21 - SC_047h_047v_120_20Hz_1x
  SessionToken:
   type: string
   default: " "
   maxLength: 36