LifeTime Desktop API

Base URL: /api/v1, Version: 1.0

API for sending documents via LifeTime programmatically.

Default request content-types: multipart/form-data
Default response content-types: text/plain
Schemes: http, https

Summary

Path Operation Description
/info GET

Provides information about the API.
OPTIONS

Provides origin information.
/send OPTIONS

Provides origin information
POST

Sends a document using the LifeTime Desktop API.

Security

basicAuth

Type: basic
Description:

HTTP Basic Authentication using lifetime as username and the auth token from the LifeTime Desktop configuration as password.

Paths

Provides information about the API.

GET /info

Provides information about the API.

Uses default content-types: text/plain

200 OK

Successful request

version: string

Version of the LifeTime Desktop instance providing the API.

"1.7.0"
401 Unauthorized #/responses/Unauthorized

Authentication information missing
WWW-Authenticate string
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
403 Forbidden #/responses/Forbidden

Authentication failed
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
Provides origin information.

OPTIONS /info

Provides origin information.

Uses default content-types: text/plain

204 No Content
Access-Control-Allow-Credentials boolean true
Access-Control-Max-Age integer 86400
Access-Control-Allow-Methods string GET,OPTIONS
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
Provides origin information

OPTIONS /send

Provides origin information

Uses default content-types: text/plain

204 No Content
Access-Control-Allow-Credentials boolean true
Access-Control-Max-Age integer 86400
Access-Control-Allow-Methods string POST,OPTIONS
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
Sends a document using the LifeTime Desktop API.

POST /send

Sends a document using the LifeTime Desktop API.
document

The document to be sent

 formData file
inr

German insurance number of the recipient

 formData string
mobile

Mobile number of the recipient

 formData string

application/json

200 OK

Successful dispatch of the document.

patientState: string , x ∈ { new , existing , changed }

Information about the recipient. Has it been newly created ("new"), was it known ("existing") or was it known but changed due to a different insurance number ("changed").

"new"
tan: object

Information about TAN usage

used: boolean

Indicates if a TAN has been generated and used to send the document

tanRaw: string

TAN in its raw format (only set if used === true)

123456789
tanDisplay: string

TAN in its display format as used in Desktop and the apps (only set if used === true)

"123 - 456 - 789"
400 Bad Request #/responses/BadRequest

Invalid or missing parameters
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
401 Unauthorized #/responses/Unauthorized

Authentication information missing
WWW-Authenticate string
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
403 Forbidden #/responses/Forbidden

Authentication failed
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
500 Internal Server Error #/responses/InternalServerError

An internal error occured when processing the request
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string

Response definitions

Unauthorized

Authentication information missing
WWW-Authenticate string
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
Forbidden

Authentication failed
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
BadRequest

Invalid or missing parameters
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string
InternalServerError

An internal error occured when processing the request
Access-Control-Allow-Credentials boolean true
Access-Control-Allow-Origin

Returns the value of the origin header if it is set

 string