labelixa-com Devices API

openapi: 3.2.0
info:
  title: Labelixa Com Devices API
  version: 0.4.0
  description: 'Operations tagged Devices across 2 of this provider''s published API definitions: labelixa-com-api-openapi.json, labelixa-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Devices
paths:
  /v1/devices:
    get:
      summary: List printers
      operationId: cihaz_listesi_v1_devices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      description: Lists the registered printer profiles. Records that appear to point at the same physical printer are flagged in `ayni_fiziksel_cihaz`. Requires an account on a plan with printing (Starter and above, or the free print trial).
      tags:
      - Devices
    post:
      summary: Register printer
      description: 'Registers a printer profile (201): `takma_ad`, `grup`, `dpmm`, `genislik_dots`, `varsayilan_mi`, `dil` (zpl, epl, tspl, cpcl or raw) and `adaptor`. Serial number and network address are not accepted; finding the device on the network is the agent''s job. Requires an account on a plan with printing (Starter and above, or the free print trial).'
      operationId: cihaz_ekle_v1_devices_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CihazIstegi'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Devices
  /v1/devices/{cihaz_id}:
    delete:
      summary: Delete printer
      operationId: cihaz_sil_v1_devices__cihaz_id__delete
      parameters:
      - name: cihaz_id
        in: path
        required: true
        schema:
          type: string
          title: Cihaz Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Deletes a printer profile. 404 when not found.
      tags:
      - Devices
  /v1/devices/{cihaz_id}/status:
    get:
      summary: Printer status
      description: 'What the cloud can see about the device: profile, queued job counts, age of the oldest waiting job, last job, agent liveness and whether any agent maps the device (`cihaz_eslenmis`: true, false or null for unknown). The printer''s physical state (media, printhead, jam) cannot be read over a raw socket, so `yazici_durumu` is `"BILINMIYOR"` (unknown) with the reason. `kimlik` reports the identity check the agent runs in front of every job for a pinned device (`sabitlendi`, `son_dogrulama`, `son_sonuc`, `son_sonuc_zamani`); `verified` proves the device that answered was the pinned one, not that a label came out. Someone else''s resource and a non-existent one return the same 404.'
      operationId: cihaz_durumu_v1_devices__cihaz_id__status_get
      parameters:
      - name: cihaz_id
        in: path
        required: true
        schema:
          type: string
          title: Cihaz Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Devices
  /v1/devices/{cihaz_id}/test-print:
    post:
      summary: Queue test print
      description: 'Queues a standard test label sized for the device profile, to verify the setup without writing ZPL. An ordinary print job: same queue and limits; 202 is not a print confirmation. 400 when the device language is `raw`; 429 with `Retry-After` when the queue is full.'
      operationId: cihaz_test_baskisi_v1_devices__cihaz_id__test_print_post
      parameters:
      - name: cihaz_id
        in: path
        required: true
        schema:
          type: string
          title: Cihaz Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Devices
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CihazIstegi:
      properties:
        takma_ad:
          type: string
          title: Takma Ad
        dpmm:
          type: integer
          title: Dpmm
          default: 8
        genislik_dots:
          type: integer
          title: Genislik Dots
          default: 812
        varsayilan_mi:
          type: boolean
          title: Varsayilan Mi
          default: false
        dil:
          type: string
          title: Dil
          default: zpl
        adaptor:
          type: string
          title: Adaptor
          default: raw_tcp
        grup:
          type: string
          title: Grup
          default: ''
      type: object
      required:
      - takma_ad
      title: CihazIstegi
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json