The service to generate video appointment codes can be requested with JSON (HTTP POST). The active version of our api is a small RESTful service interface, available via following url:
https://video.redmedical.de/api/codes
Request
Request Type: HTTP POST
Header
Field | Value | Description |
Authorization | <your token> | supply your api token with <your token> |
Content-Type | application/json |
Body parameter
Field | Type | Description |
validTo | string, required | format: "YYYY-MM-DD" or long version as ISO string "YYYY-MM-DDTHH:mm:ss.SSSZ" date until entry code is valid |
tenantId | number, optional | additional information about specific tenant, usually not necessary |
Example body:
{ “validTo”: “2022-01-31” } |
Response
Success:
HTTP Status Code: 201
Field | Type | Description |
hostCode | string | the code for the video appointment host - former “codeArzt” |
clientCode | string | the code for the video appointment participent - former “codePatient” |
created | date | timestamp of creation |
Example:
HTTP/1.1 201 OK { “hostCode”: “21h-hEY-DMe”, “clientCode”: “J2M-KRv-Dkb”, “created”: “2020-08-27T05:38:11.564Z” } |
The video appointment can be accessed by all participants via the following URL:
https://video.redmedical.de/#/login?name=[name]&code=[code]
In protection of privacy do not use any patient clear text names.
Errors
HTTP Status Code: 401
If you get the HTTP status code 401, the given token is invalid. Please check your token and request header definitions.
