GET /v1/server/findByIk

[nikzen]

  /v1/server/findByIk:
    get:
      tags:
        - lookUpServer
      summary: "Resolve an IK number to the associated TI-Messenger server name."
      parameters:
        - in: query
          name: ikNumber
          description: "IK number to look up."
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: object
                required:
                  - serverName
                properties:
                  serverName:
                    type: string
                    description: "The TI-Messenger server name for the given IK number."
                    example: "gematiker-kk.de"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"

This endpoint will return a domain which matches to the ik number. This information is stored on the federationlist. Currently there is no test environment for the federation list and also the schema provided by gematik (link) is not updated. To be able to implement this, we need to use the openapi spec, there they have the new definition (link).

This endpoint should only be activated for tim-pro mode.

[nico-famedly]

To be able to do the reverse lookup, we need this info to be part of the federation list. Otherwise we would have to query every server for their ikNumber, afaik. What's the state on getting the federation list schema updated?

[Johennes]

Upstream tracking issue: gematik/api-vzd#149

Disclaimer: I don't currently know if the format in the linked PR is actually correct.

[nico-famedly]

Ah, perfect! I didn't expect to see you here, but thanks a lot for the update! :)

[nico-famedly]

Ah, perfect! I didn't expect to see you here, but thanks a lot for the update! :)