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

# Form özetini getir

> Belirli bir form-tesis-yıl kombinasyonu için gönderim durumunu özetler.

**Parametreler**:
- `formId`: Form kimliği
- `siteId`: Tesis kimliği
- `year`: Rapor yılı

**Özet şu bilgileri içerir**:
- **Tamamlama durumu**: İlerleme, eksik veri, doğrulama durumu
- **Öğe kapsamı**: Hangi form öğelerinin tamamlandığı
- **Veri kalitesi**: Doğrulama sorunları ve eksik gönderimler
- **Zaman analizi**: Dönem bazında (ay/çeyrek) tamamlama oranları
- **Dosya ekleri**: Destekleyici belgelerin durumu
- **Gönderim geçmişi**: Veri giriş ve güncelleme zaman çizelgesi

**Kullanım senaryoları**:
- Veri toplama kampanyalarının ilerlemesini takip etmek
- Uyum raporlaması hazırlıkları
- Veri kalitesi değerlendirmeleri
- Tamamlama metriği gösteren pano bileşenleri
- Otomatik uyarı ve raporlama sistemleri



## OpenAPI

````yaml https://app.azalt.co/api/v1/openapi.tr.json get /forms/{formId}/sites/{siteId}/years/{year}/summary
openapi: 3.0.3
info:
  title: Erguvan Genel API
  version: 1.0.0
  description: Erguvan platformuna entegrasyon için REST API referansının Türkçe sürümü.
servers:
  - url: https://app.azalt.co/api/v1
security: []
tags:
  - name: Activity
    x-displayName: Aktiviteler
  - name: ActivityDefinition
    x-displayName: Aktivite Tanımları
  - name: ApiKey
    x-displayName: API Anahtarları
  - name: Dashboard
    x-displayName: Panolar
  - name: DashboardWidget
    x-displayName: Pano Bileşenleri
  - name: Dataset
    x-displayName: Veri Setleri
  - name: DatasetItem
    x-displayName: Veri Seti Öğeleri
  - name: File
    x-displayName: Dosyalar
  - name: Form
    x-displayName: Formlar
  - name: FormElement
    x-displayName: Form Öğeleri
  - name: FormElementSubmission
    x-displayName: Form Öğesi Gönderimleri
  - name: FormSite
    x-displayName: Form-Tesis İlişkilendirmeleri
  - name: FormSubmission
    x-displayName: Form Gönderimleri
  - name: Indicator
    x-displayName: Göstergeler
  - name: Organization
    x-displayName: Organizasyonlar
  - name: Site
    x-displayName: Tesisler
  - name: Target
    x-displayName: Hedefler
  - name: Unit
    x-displayName: Birimler
  - name: User
    x-displayName: Kullanıcılar
paths:
  /forms/{formId}/sites/{siteId}/years/{year}/summary:
    get:
      tags:
        - Form
      summary: Form özetini getir
      description: |-
        Belirli bir form-tesis-yıl kombinasyonu için gönderim durumunu özetler.

        **Parametreler**:
        - `formId`: Form kimliği
        - `siteId`: Tesis kimliği
        - `year`: Rapor yılı

        **Özet şu bilgileri içerir**:
        - **Tamamlama durumu**: İlerleme, eksik veri, doğrulama durumu
        - **Öğe kapsamı**: Hangi form öğelerinin tamamlandığı
        - **Veri kalitesi**: Doğrulama sorunları ve eksik gönderimler
        - **Zaman analizi**: Dönem bazında (ay/çeyrek) tamamlama oranları
        - **Dosya ekleri**: Destekleyici belgelerin durumu
        - **Gönderim geçmişi**: Veri giriş ve güncelleme zaman çizelgesi

        **Kullanım senaryoları**:
        - Veri toplama kampanyalarının ilerlemesini takip etmek
        - Uyum raporlaması hazırlıkları
        - Veri kalitesi değerlendirmeleri
        - Tamamlama metriği gösteren pano bileşenleri
        - Otomatik uyarı ve raporlama sistemleri
      operationId: getFormSummary
      parameters:
        - in: path
          name: formId
          schema:
            type: string
          required: true
        - in: path
          name: siteId
          schema:
            type: string
          required: true
        - in: path
          name: year
          schema:
            type: number
          required: true
        - in: query
          name: scoreMin
          schema:
            type: number
        - in: query
          name: scoreMax
          schema:
            type: number
        - in: query
          name: elementId
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSubmissions:
                    type: number
                  elementSummaries:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        type:
                          type: string
                        label:
                          type: string
                        periodStats:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              count:
                                type: number
                              periodUnit:
                                type: number
                              average:
                                type: number
                              min:
                                type: number
                              max:
                                type: number
                              sum:
                                type: number
                              optionCounts:
                                type: object
                                additionalProperties:
                                  type: number
                              textResponses:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                    length:
                                      type: number
                                    submissionId:
                                      type: string
                                  required:
                                    - text
                                    - length
                            required:
                              - count
                              - periodUnit
                      required:
                        - type
                        - label
                        - periodStats
                  progressRate:
                    type: number
                required:
                  - totalSubmissions
                  - elementSummaries
                  - progressRate
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````