Helper

Retrieve HTML File

get

Retrieves an HTML file stored in Firebase using an encrypted token passed as a query parameter.

Query Parameter

token (string, required): Encrypted token representing the user, session, and file name. This token is used to locate and decrypt the corresponding HTML file.

Response (HTTP 200)

On success, returns the content of the HTML file with a Content-Type of text/html.

<html><body><h1>Example HTML</h1></body></html>

Error Handling

400 Bad Request: Returned if the token query parameter is missing or empty.
404 Not Found: Returned if the HTML file cannot be retrieved (e.g., invalid token or file not found).
500 Internal Server Error: Returned if an unexpected error occurs on the server.

Security

No authentication is required for this endpoint.

Query parameters

tokenstringRequired

Encrypted token used to retrieve the HTML file.

Responses

200

HTML file retrieved successfully.

application/json

Responsestring

The HTML file content.

Example: <html><body><h1>Example HTML</h1></body></html>

400

Bad Request - Returned if the token parameter is missing or empty. Ensure that the token is provided in the query string.

application/json

404

Not Found - Returned if the HTML file cannot be retrieved. This may be due to an invalid token or if the file does not exist.

application/json

500

Internal Server Error - Returned if an unexpected error occurred on the server. Check the error details for further information.

application/json

get

/helper/html-files/

GET /helper/html-files/?token=text HTTP/1.1
Host: api.aikynetix.app
Accept: */*

<html><body><h1>Example HTML</h1></body></html>

Upload HTML File

post

Uploads an HTML file to Firebase for a specific session. The file must be provided as form-data with a key html_file and have a content type of 'text/html'. Additionally, the session_id must be included in the form-data to associate the file with a session.

Form Data

html_file (file, required): The HTML file to be uploaded. Only files with content type 'text/html' are accepted.
session_id (string, required): The session ID associated with the uploaded HTML file.

Response (HTTP 201)

On success, returns a JSON object containing:

message (string): A confirmation message indicating that the file was uploaded successfully.
token (string): An encrypted token representing the file and session information.

Error Handling

400 Bad Request: Returned if required fields are missing (e.g. no file or session ID provided), if the file type is not 'text/html', or if the admin UID is invalid.
404 Not Found: Returned if the session ID does not exist in Firestore. This indicates that the session ID provided does not match any existing session in the database.
422 Unprocessable Entity: Returned if the HTML file processing (e.g., encryption) fails.
500 Internal Server Error: Returned if an unexpected error occurs on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Body

html_filestringRequired

The HTML file to upload. Must have the content type 'text/html'.

session_idstringRequired

The session ID to associate with the uploaded HTML file.

Responses

201

File uploaded successfully.

application/json

400

Bad Request - Returned if required fields are missing (e.g., no file provided, session ID missing), if the file type is invalid (only HTML files are allowed), or if the admin UID is invalid.

application/json

404

Not Found - Returned if the session ID does not exist in Firestore.

application/json

422

Unprocessable Entity - Returned if the HTML file processing (e.g., encryption) fails.

application/json

500

Internal Server Error - Returned if an unexpected error occurs on the server.

application/json

post

/helper/html-files/

POST /helper/html-files/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"html_file='text'&session_id='text'"

{
  "message": "text",
  "token": "text"
}

Retrieve Session Comments

get

Retrieves the report comments for a specific session.

Path Parameter

session_id (string, required): The unique identifier of the session for which comments are requested.

Response Structure (HTTP 200)

On success, the response is a JSON object containing language-specific comments. For example:

text_summary (object): Contains summary comments in different languages.
- en (string): Summary in English.
- ru (string): Summary in Russian.
text_contact_angle (object): Contact angle comments.
text_push_angle (object): Push angle comments.
text_knee_ankle (object): Knee-ankle comments.
text_hip_angle (object): Hip angle comments.
text_left_ankle_angle (object): Left ankle angle comments.
text_left_knee_angle (object): Left knee angle comments.
text_right_ankle_angle (object): Right ankle angle comments.
text_right_knee_angle (object): Right knee angle comments.

Error Handling

400 Bad Request: Invalid request parameters.
401 Unauthorized: Missing or invalid access token.
403 Forbidden: Insufficient privileges (admin access required).
404 Not Found: Comments not found for the given session.
500 Internal Server Error: An unexpected error occurred on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Path parameters

session_idanyRequired

Responses

200

Session comments retrieved successfully.

application/json

400

Bad Request - Error getting comments due to invalid parameters.

application/json

401

Unauthorized - Missing or invalid access token.

application/json

403

Forbidden - Admin access is required.

application/json

404

Not Found - Comments not found for the given session.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

get

/helper/sessions/{session_id}/report-comments/

GET /helper/sessions/{session_id}/report-comments/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "text_summary": {
    "en": "text",
    "ru": "text"
  },
  "text_contact_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_push_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_knee_ankle": {
    "en": "text",
    "ru": "text"
  },
  "text_hip_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_left_ankle_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_left_knee_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_right_ankle_angle": {
    "en": "text",
    "ru": "text"
  },
  "text_right_knee_angle": {
    "en": "text",
    "ru": "text"
  }
}

Update Session Comments

post

Updates the report comments for a specific session. The request body must include the comment fields for various aspects of the session (e.g., summary, contact angle, push angle, etc.) in multiple languages.

Request Body (JSON)

The following fields are expected (all fields are objects with language keys):

text_summary (object): Summary comments (e.g., {'en': 'English text', 'ru': 'Russian text'}).
text_contact_angle (object): Contact angle comments.
text_push_angle (object): Push angle comments.
text_knee_ankle (object): Knee ankle comments.
text_hip_angle (object): Hip angle comments.
text_left_ankle_angle (object): Left ankle angle comments.
text_left_knee_angle (object): Left knee angle comments.
text_right_ankle_angle (object): Right ankle angle comments.
text_right_knee_angle (object): Right knee angle comments.

Response Structure (HTTP 200)

On success, the response is a JSON object with:

message (string): A confirmation message indicating that comments were updated.

Error Handling

400 Bad Request: If the input data is missing or invalid.
401 Unauthorized: If the access token is missing or invalid.
403 Forbidden: If the user does not have admin privileges.
500 Internal Server Error: If an unexpected error occurs on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Path parameters

session_idanyRequired

Body

Responses

200

Comments updated successfully.

application/json

400

Bad Request - Error updating comments due to missing or invalid data.

application/json

401

Unauthorized - Missing or invalid access token.

application/json

403

Forbidden - Admin privileges are required.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

post

/helper/sessions/{session_id}/report-comments/

POST /helper/sessions/{session_id}/report-comments/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 862

{
  "text_summary": {
    "en": "Summary text in English",
    "ru": "Summary text in Russian"
  },
  "text_contact_angle": {
    "en": "Contact angle text in English",
    "ru": "Contact angle text in Russian"
  },
  "text_push_angle": {
    "en": "Push angle text in English",
    "ru": "Push angle text in Russian"
  },
  "text_knee_ankle": {
    "en": "Knee ankle text in English",
    "ru": "Knee ankle text in Russian"
  },
  "text_hip_angle": {
    "en": "Hip angle text in English",
    "ru": "Hip angle text in Russian"
  },
  "text_left_ankle_angle": {
    "en": "Left ankle angle text in English",
    "ru": "Left ankle angle text in Russian"
  },
  "text_left_knee_angle": {
    "en": "Left knee angle text in English",
    "ru": "Left knee angle text in Russian"
  },
  "text_right_ankle_angle": {
    "en": "Right ankle angle text in English",
    "ru": "Right ankle angle text in Russian"
  },
  "text_right_knee_angle": {
    "en": "Right knee angle text in English",
    "ru": "Right knee angle text in Russian"
  }
}

{
  "message": "text"
}

Delete Report Comments

delete

Deletes all report comments for a given session.

Request

Path Parameter:
- session_id (string, required): The unique identifier of the session whose report comments will be deleted.

Response Structure (HTTP 200)

On success, the response is a JSON object with:

message (string): A success message indicating that the comments have been deleted.

Error Handling

400 Bad Request: Indicates that the request parameters are invalid or that an error occurred during deletion.
401 Unauthorized: The access token is missing or invalid.
403 Forbidden: The user does not have admin privileges to delete report comments.
404 Not Found: The session or report comments were not found.
500 Internal Server Error: An unexpected error occurred on the server.

Security

A valid API-KEY token must be provided in the Authorization header.

Authorizations

AuthorizationstringRequired

Enter your bearer token (Firebase auth) in the format: Bearer

Path parameters

session_idanyRequired

Responses

200

Comments deleted successfully.

application/json

400

Bad Request - Error deleting comments (e.g., invalid parameters).

application/json

401

Unauthorized - Missing or invalid access token.

application/json

403

Forbidden - The user does not have admin privileges to delete report comments.

application/json

404

Not Found - The session or report comments were not found.

application/json

500

Internal Server Error - An unexpected error occurred on the server.

application/json

delete

/helper/sessions/{session_id}/report-comments/

DELETE /helper/sessions/{session_id}/report-comments/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "text"
}

PreviousDashboard Running NextJumping

Last updated 5 months ago

Was this helpful?

hashtagRetrieve HTML File

hashtagQuery Parameter

hashtagResponse (HTTP 200)

hashtagError Handling

hashtagSecurity

hashtagUpload HTML File

hashtagForm Data

hashtagResponse (HTTP 201)

hashtagError Handling

hashtagSecurity

hashtagRetrieve Session Comments

hashtagPath Parameter

hashtagResponse Structure (HTTP 200)

hashtagError Handling

hashtagSecurity

hashtagUpdate Session Comments

hashtagRequest Body (JSON)

hashtagResponse Structure (HTTP 200)

hashtagError Handling

hashtagSecurity

hashtagDelete Report Comments

hashtagRequest

hashtagResponse Structure (HTTP 200)

hashtagError Handling

hashtagSecurity

Retrieve HTML File

Query Parameter

Response (HTTP 200)

Error Handling

Security

Upload HTML File

Form Data

Response (HTTP 201)

Error Handling

Security

Retrieve Session Comments

Path Parameter

Response Structure (HTTP 200)

Error Handling

Security

Update Session Comments

Request Body (JSON)

Response Structure (HTTP 200)

Error Handling

Security

Delete Report Comments

Request

Response Structure (HTTP 200)

Error Handling

Security