openapi: 3.0.1
info:
  title: An api for infections alert apps based on a server network under the XIAnet architecture.
  description: Provides a personal risk score and international and multi-level suspicious contact tracking without sending any personal data to the servers. Complies with GDPR privacy standard. See "https://infect-alert.org" and the documentation on "https://infect-alert.org/wp-content/uploads/2017/07/XIA_en.pdf".
  version: '0.1'
servers:
  - url: 'https://xia.xaption.net'
paths:
  /xaption/xia/getStatus:
    get:
      description: Usage by mobile device app. Provides personal risk score and single-level information of the suspicious contacts.
      parameters:
        - name: c
          in: query
          schema:
            type: string
          example: DE
        - name: id
          in: query
          schema:
            type: string
          example: D4AE52BBD66C1EEA9DEC4210A413054F
      responses:
        '200':
          description: Request successful
          content:
            application/json; charset=utf-8:
              schema:
                type: string
              examples: {}
      servers:
        - url: 'https://xia.xaption.net'
    post:
      description: Usage by mobile device app. Provides personal risk score and multi-level information of the suspicious contacts.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                contacts:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      dur:
                        type: integer
                      c:
                        type: string
                      id:
                        type: string
            examples:
              '0':
                value: |-
                  {
                      "id": "D4AE52BBD66C1EDA9DE7D970DFE7D78F",
                      "contacts": [
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4210A413054F",
                              "date": "20200401",
                              "dur": 4
                          },
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4757D2908559",
                              "date": "20200405",
                              "dur": 10
                          }
                      ]
                  }
      responses:
        '200':
          description: Request sucessful
          content:
            application/json; charset=utf-8:
              schema:
                type: string
              examples: {}
      servers:
        - url: 'https://xia.xaption.net'
    servers:
      - url: 'https://xia.xaption.net'
  /xaption/xia/getTan:
    get:
      description: Provides a TAN to give to an infected person to send health status with severity of 7 and above using addId. Basic authentication required. Use DOCTOR / Clinic for test server.
      responses:
        '200':
          description: TAN generated, see plain text body
          content:
            text/plain; charset=utf-8:
              schema:
                type: string
              examples: {}
      servers:
        - url: 'https://xia.xaption.net'
    servers:
      - url: 'https://xia.xaption.net'
  /xaption/xia/addId:
    post:
      description: Send personal health status to a national trust center. For severity levels of 7 and above, a TAN is needed. 
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tan:
                  type: integer
                sd:
                  type: string
                s:
                  type: string
                id:
                  type: string
                contacts:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      dur:
                        type: integer
                      c:
                        type: string
                      id:
                        type: string
            examples:
              '0':
                value: |-
                  {
                      "id": "D4AE52BBD66C1EDA9DE7D970DFE7D78F",
                      "s": "3",
                      "sd": "20200407",
                      "contacts": [
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4210A413054F",
                              "date": "20200401",
                              "dur": 4
                          },
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4757D2908559",
                              "date": "20200405",
                              "dur": 10
                          }
                      ]
                  }
              '1':
                value: |-
                  {
                      "id": "D4AE52BBD66C1EDA9DE7D970DFE7D78F",
                      "s": "7",
                      "sd": "20200409",
                      "tan": 116607,
                      "contacts": [
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4210A413054F",
                              "date": "20200401",
                              "dur": 4
                          },
                          {
                              "c": "DE",
                              "id": "D4AE52BBD66C1EEA9DEC4757D2908559",
                              "date": "20200405",
                              "dur": 10
                          }
                      ]
                  }
      responses:
        '200':
          description: Status send and updated on national trust center servers
        '401':
          description: TAN missing or invalid TAN
      servers:
        - url: 'https://xia.xaption.net'
    servers:
      - url: 'https://xia.xaption.net'
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic