> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seam.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Report Devices

> Reports ACS system device status including encoders and entrances.



## OpenAPI

````yaml /openapi.json post /acs/systems/report_devices
openapi: 3.0.0
info:
  title: Seam Connect
  version: 1.0.0
servers:
  - url: https://connect.getseam.com
security: []
tags:
  - description: access_codes
    name: /access_codes
  - description: acs
    name: /acs
  - description: action_attempts
    name: /action_attempts
  - description: client_sessions
    name: /client_sessions
  - description: connected_accounts
    name: /connected_accounts
  - description: connect_webviews
    name: /connect_webviews
  - description: devices
    name: /devices
  - description: events
    name: /events
  - description: health
    name: /health
  - description: locks
    name: /locks
  - description: networks
    name: /networks
  - description: noise_sensors
    name: /noise_sensors
  - description: phones
    name: /phones
  - description: thermostats
    name: /thermostats
  - description: user_identities
    name: /user_identities
  - description: webhooks
    name: /webhooks
  - description: workspaces
    name: /workspaces
paths:
  /acs/systems/report_devices:
    post:
      tags:
        - /acs
      summary: Report Devices
      description: Reports ACS system device status including encoders and entrances.
      operationId: acsSystemsReportDevicesPost
      requestBody:
        content:
          application/json:
            schema:
              properties:
                acs_encoders:
                  default: []
                  description: Array of ACS encoders to report
                  items:
                    properties:
                      hotek_metadata:
                        description: Hotek-specific metadata associated with the entrance.
                        properties:
                          encoder_number:
                            description: >-
                              The encoder number determined by the USB port
                              connection.
                            type: string
                        required:
                          - encoder_number
                        type: object
                      is_removed:
                        default: false
                        description: Whether the encoder is removed
                        type: boolean
                    required:
                      - hotek_metadata
                    type: object
                  type: array
                acs_entrances:
                  default: []
                  description: Array of ACS entrances to report
                  items:
                    properties:
                      hotek_metadata:
                        description: Hotek-specific metadata associated with the entrance.
                        properties:
                          common_area_name:
                            description: The common area name
                            type: string
                          common_area_number:
                            description: The room number identifier
                            type: string
                          room_number:
                            description: The room number identifier
                            type: string
                        type: object
                      is_removed:
                        default: false
                        description: Whether the entrance is removed
                        type: boolean
                    required:
                      - hotek_metadata
                    type: object
                  type: array
                acs_system_id:
                  description: ID of the ACS system to report resources for
                  format: uuid
                  type: string
              required:
                - acs_system_id
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  ok:
                    type: boolean
                required:
                  - ok
                type: object
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
        - pat_with_workspace: []
        - console_session_with_workspace: []
        - api_key: []
      x-codeSamples:
        - lang: javascript
          label: Seam SDK
          source: |-
            await seam.acs.systems.reportDevices({
              acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
              acs_encoders: [
                { hotek_metadata: { encoder_number: "1" } },
                { is_removed: true, hotek_metadata: { encoder_number: "2" } },
              ],
              acs_entrances: [
                { hotek_metadata: { room_number: "203" } },
                { is_removed: true, hotek_metadata: { room_number: "500" } },
                { hotek_metadata: { common_area_name: "Gym", common_area_number: "2" } },
              ],
            });

            /*
            // void
            */
        - lang: bash
          label: cURL
          source: >-
            curl --include --request POST
            "https://connect.getseam.com/acs/systems/report_devices" \
              --header "Authorization: Bearer $SEAM_API_KEY" \
              --json @- <<EOF
            {
              "acs_system_id": "182ea706-8e14-4921-8e57-ee18d5a7de31",
              "acs_encoders": [
                {
                  "hotek_metadata": {
                    "encoder_number": "1"
                  }
                },
                {
                  "is_removed": true,
                  "hotek_metadata": {
                    "encoder_number": "2"
                  }
                }
              ],
              "acs_entrances": [
                {
                  "hotek_metadata": {
                    "room_number": "203"
                  }
                },
                {
                  "is_removed": true,
                  "hotek_metadata": {
                    "room_number": "500"
                  }
                },
                {
                  "hotek_metadata": {
                    "common_area_name": "Gym",
                    "common_area_number": "2"
                  }
                }
              ]
            }

            EOF


            # Response:

            # {}
        - lang: python
          label: Seam SDK
          source: |-
            seam.acs.systems.report_devices(
                acs_system_id="182ea706-8e14-4921-8e57-ee18d5a7de31",
                acs_encoders=[
                    {"hotek_metadata": {"encoder_number": "1"}},
                    {"is_removed": true, "hotek_metadata": {"encoder_number": "2"}},
                ],
                acs_entrances=[
                    {"hotek_metadata": {"room_number": "203"}},
                    {"is_removed": true, "hotek_metadata": {"room_number": "500"}},
                    {"hotek_metadata": {"common_area_name": "Gym", "common_area_number": "2"}},
                ],
            )

            # None
        - lang: ruby
          label: Seam SDK
          source: |-
            seam.acs.systems.report_devices(
              acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
              acs_encoders: [
                { hotek_metadata: { encoder_number: "1" } },
                { is_removed: true, hotek_metadata: { encoder_number: "2" } },
              ],
              acs_entrances: [
                { hotek_metadata: { room_number: "203" } },
                { is_removed: true, hotek_metadata: { room_number: "500" } },
                { hotek_metadata: { common_area_name: "Gym", common_area_number: "2" } },
              ],
            )

            # => nil
        - lang: php
          label: Seam SDK
          source: |-
            $seam->acs->systems->report_devices(
                acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
                acs_encoders: [
                    ["hotek_metadata" => ["encoder_number" => "1"]],
                    ["is_removed" => true, "hotek_metadata" => ["encoder_number" => "2"]],
                ],
                acs_entrances: [
                    ["hotek_metadata" => ["room_number" => "203"]],
                    ["is_removed" => true, "hotek_metadata" => ["room_number" => "500"]],
                    [
                        "hotek_metadata" => [
                            "common_area_name" => "Gym",
                            "common_area_number" => "2",
                        ],
                    ],
                ],
            );
        - lang: bash
          label: Seam CLI
          source: >-
            seam acs systems report-devices --acs_system_id
            "182ea706-8e14-4921-8e57-ee18d5a7de31" --acs_encoders
            [{"hotek_metadata":{"encoder_number":"1"}},{"is_removed":true,"hotek_metadata":{"encoder_number":"2"}}]
            --acs_entrances
            [{"hotek_metadata":{"room_number":"203"}},{"is_removed":true,"hotek_metadata":{"room_number":"500"}},{"hotek_metadata":{"common_area_name":"Gym","common_area_number":"2"}}]


            # {}
components:
  securitySchemes:
    pat_with_workspace:
      bearerFormat: API Token
      scheme: bearer
      type: http
    console_session_with_workspace:
      bearerFormat: Console Session Token
      scheme: bearer
      type: http
    api_key:
      bearerFormat: API Key
      scheme: bearer
      type: http

````