README

🏗️ Aquaticus — Projects API Guide

Everything you need to register & authenticate, create and manage clients & projects, and run calculations using ProjectVariables.

ℹ️ Email verification is required to:

Create clients (POST /client)

Create projects (POST /project) — requires an existing clientId

Run calculations (POST /calculate, GET /calculate/{projectId})

🚀 Quick Start

1) Register

curl -X POST https://api.aquaticus.tech/register \
  -H "Content-Type: application/json" \
  -d '{
        "email":"user@example.com",
        "password":"StrongPass123!"
      }'

Response

{ "token": "JWT_TOKEN" }

Defaults applied

Text fields are trimmed of leading/trailing spaces.
isEmailVerified is false until confirmed (or social login succeeds).
The issued session token is valid for 30 days.

curl -X POST https://api.aquaticus.tech/login \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"StrongPass123!"}'

3) Verify your email (required for creating clients/projects and running calculations)

# Send confirmation code
curl -X POST https://api.aquaticus.tech/sendEmailConfirmationCode \
  -H "Authorization: Bearer JWT_TOKEN"

# Confirm
curl -X POST https://api.aquaticus.tech/confirmEmail \
  -H "Authorization: Bearer JWT_TOKEN" \
  -H "Content-Type: text/plain" \
  -d "123456"

Using social login is an alternative way to verify user’s email. After any social login is done successfully the email is marked verified

curl -X POST https://api.aquaticus.tech/login/google \
  -H "Content-Type: text/plain" \
  -d "SOCIAL_ACCESS_TOKEN"

(Replace google with facebook, apple, or microsoft)

https://api.aquaticus.tech/__microsoft

https://api.aquaticus.tech/__google

https://api.aquaticus.tech/__facebook

https://api.aquaticus.tech/__apple

4) Create a client ➜ requires verified email

curl -X POST https://api.aquaticus.tech/client \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "client@example.com",
        "name": "Acme Resorts",
        "phoneNumber": "+1 555 222 3333",
        "address": "456 Resort Way, San Diego, CA"
      }'

Response

{
  "id": 77,
  "email": "client@example.com",
  "name": "Acme Resorts",
  "phoneNumber": "+1 555 222 3333",
  "address": "456 Resort Way, San Diego, CA"
}

5) Create a project ➜ requires verified email & an existing `clientId`

curl -X POST https://api.aquaticus.tech/project \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Sunset Villas – Pool A",
        "clientId": 77,
        "variables": {
          "shape": "rectangle",
          "length": 30.0,
          "width": 15.0,
          "finishThickness": 0.5,
          "depthProfileType": "standard",
          "shallowDepth": 3.5,
          "deepDepth": 8.0,
          "shallowLengthPercentage": 30.0,
          "wallThickness": 8.0,
          "floorThickness": 6.0,
          "beamHeight": 6.0,
          "beamThickness": 12.0,
          "gravelThickness": 6.0,
          "steelPatternWall": "#4 @ 12\" OC",
          "steelPatternFloor": "#4 @ 12\" OC",
          "hasSteps": false,
          "hasBench": false,
          "turnoverHours": 6.0,
          "minVelocitySuction": 3.0,
          "maxVelocitySuction": 5.0,
          "minVelocityReturn": 6.0,
          "maxVelocityReturn": 8.0,
          "pipeRunLength": 30.0
        }
      }'

6) Calculate from raw variables ➜ requires verified email

curl -X POST https://api.aquaticus.tech/calculate \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  --data-binary @project-variables.json

7) Calculate for a saved project ➜ requires verified email

curl -X GET https://api.aquaticus.tech/calculate/{projectId} \
  -H "Authorization: Bearer <JWT_TOKEN>"

8) List projects

# All my projects
curl -X GET https://api.aquaticus.tech/projects \
  -H "Authorization: Bearer <JWT_TOKEN>"

# Projects for a client
curl -X GET https://api.aquaticus.tech/projects/{clientId} \
  -H "Authorization: Bearer <JWT_TOKEN>"

🧰 Tools — Temporary Variables API

Save and retrieve temporary ProjectVariables payloads for quick drafts or calculations.

Auth: JWT + verified email (same requirements as Projects & Calculations)

Endpoints

Method	Path	Auth	Description
GET	`/tools`	JWT + verified email	Get the latest temporary variables (raw JSON)
POST	`/tools`	JWT + verified email	Save a temporary `ProjectVariables` payload

Get the latest temporary variable set

Returns only the variables object itself. No wrapper. No id. No timestamps.

curl -X GET https://api.aquaticus.tech/tools \
  -H "Authorization: Bearer <JWT_TOKEN>"

Response (raw ProjectVariables):

{
  "shape": "rectangle",
  "length": 30.0,
  "width": 15.0,
  "finishThickness": 0.5,
  "depthProfileType": "standard",
  "shallowDepth": 3.5,
  "deepDepth": 8.0,
  "shallowLengthPercentage": 30.0,
  "wallThickness": 8.0,
  "floorThickness": 6.0,
  "beamHeight": 12.0,
  "beamThickness": 10.0,
  "gravelThickness": 6.0,
  "steelPatternWall": "#4 @ 12\" OC",
  "steelPatternFloor": "#4 @ 12\" OC",
  "hasSteps": false,
  "hasBench": false,
  "turnoverHours": 6.0,
  "minVelocitySuction": 3.0,
  "maxVelocitySuction": 5.0,
  "minVelocityReturn": 6.0,
  "maxVelocityReturn": 8.0,
  "pipeRunLength": 30.0
}

Errors

401 Unauthorized
403 Forbidden — email not verified
404 Not Found — no stored variables yet

Save a temporary variables payload

Saves a new set of ProjectVariables. No wrapper in the response.

curl -X POST https://api.aquaticus.tech/tools \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  --data-binary @project-variables.json

Response (raw ProjectVariables):

{
  "shape": "rectangle",
  "length": 30.0,
  "width": 15.0,
  "depthProfileType": "standard",
  "shallowDepth": 3.5,
  "deepDepth": 8.0
}

🔐 Authentication & Email Confirmation

(unchanged content omitted for brevity — see above for full commands)

📁 Projects API

Endpoints

Method	Path	Auth	Notes
GET	`/projects`	JWT + verified email	List my projects
GET	`/projects/{clientId}`	JWT + verified email	List my projects for a given client
GET	`/project/{id}`	JWT + verified email	Get one project
POST	`/project`	JWT + verified email	Create a project (requires `clientId`)
PATCH	`/project/{id}`	JWT + verified email	Update a project (partial)
DELETE	`/project/{id}`	JWT + verified email	Delete a project

Delete a project

Removes the project (and its variables) permanently.

Example:

curl -X DELETE https://api.aquaticus.tech/project/123 \
  -H "Authorization: Bearer <JWT_TOKEN>"

Response:

204 No Content on success
404 Not Found if the project does not exist or doesn’t belong to you

👥 Clients API

Endpoints

Method	Path	Auth	Description
GET	`/clients`	JWT + verified email	List my clients
GET	`/client/{id}`	JWT + verified email	Get one client
POST	`/client`	JWT + verified email	Create client
PATCH	`/client/{id}`	JWT + verified email	Update client (partial)
DELETE	`/client/{id}`	JWT + verified email	Delete client

Delete a client

Removes the client record.

Example:

curl -X DELETE https://api.aquaticus.tech/client/77 \
  -H "Authorization: Bearer <JWT_TOKEN>"

Response:

204 No Content on success
404 Not Found if the client does not exist or doesn’t belong to you
409 Conflict if the client has existing projects

🧮 Calculations

Endpoints

Method	Path	Auth	Description
GET	`/formulas/js`	JWT required	Download the JavaScript formulas used by apps
POST	`/calculate`	JWT + verified email	Calculate from raw `ProjectVariables`
GET	`/calculate/{projectId}`	JWT + verified email	Calculate using a saved project’s variables

Examples

Get formulas JS

curl -X GET https://api.aquaticus.tech/formulas/js \
  -H "Authorization: Bearer <JWT_TOKEN>"

Calculate from variables (requires verified email)

curl -X POST https://api.aquaticus.tech/calculate \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  --data-binary @project-variables.json

Calculate for a saved project (requires verified email)

curl -X GET https://api.aquaticus.tech/calculate/{projectId} \
  -H "Authorization: Bearer <JWT_TOKEN>"

🧱 ProjectVariables: Fields, Defaults & Validation

(unchanged; includes field list, shape rules, server defaults, UI defaults, and example payload)

Awesome—here’s a drop-in section for your guide that documents the /me endpoints in the same style as the rest of your API docs.

👤 Me — User Profile API

Manage the authenticated user’s profile. Auth: JWT required. (Email verification is not required for these endpoints, but it is still required for creating clients/projects and running calculations.)

Endpoints

Method	Path	Auth	Description
GET	`/me`	JWT required	Get the current user’s profile
PATCH	`/me`	JWT required	Update the current user’s profile

Get my profile

curl -X GET https://api.aquaticus.tech/me \
  -H "Authorization: Bearer <JWT_TOKEN>"

Response

{
  "id": 123,
  "email": "user@example.com",
  "isEmailVerified": true,
  "name": "Alex",
  "lastName": "Johnson",
  "companyName": "Acme Resorts",
  "companyAddress": "456 Resort Way, San Diego, CA",
  "phoneNumber": "+1 555 222 3333",
  "role": "Project Manager"
}

Errors

401 Unauthorized — login again

Update my profile (partial)

All fields are optional and will be trimmed. Validation uses the ranges defined below (see ✅ Validation ranges).

curl -X PATCH https://api.aquaticus.tech/me \
  -H "Authorization: Bearer <JWT_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Alex",
        "lastName": "Johnson",
        "companyName": "Acme Resorts",
        "companyAddress": "456 Resort Way, San Diego, CA",
        "phoneNumber": "+1 555 222 3333",
        "role": "Project Manager"
      }'

Body schema

{
  "name": "string | null",
  "lastName": "string | null",
  "companyName": "string | null",
  "companyAddress": "string | null",
  "phoneNumber": "string | null",
  "role": "string | null"
}

Notes

Only the provided fields are updated.
email cannot be changed here.
Whitespace is trimmed on all provided text fields.

Response

200 OK with an empty body on success (implementation returns no content)

Errors

400 Bad Request — one or more fields fail validation
404 Not Found — user does not exist

✅ Validation ranges

Password: 8 to 20 characters
Name: 2 to 40 characters
Company name: 2 to 100 characters
Project name: 2 to 100 characters
Role: 2 to 50 characters
Address: 2 to 500 characters

ℹ️ These ranges apply to /me PATCH fields where relevant (name, lastName follows Name, companyName, companyAddress, role).

✅ Validation ranges

Password: 8 to 20 characters
Name: 2 to 40 characters
Company name: 2 to 100 characters
Project name: 2 to 100 characters
Role: 2 to 50 characters
Address: 2 to 500 characters

⚠️ Notes & errors

You must verify your email before creating clients/projects or running any calculations.
Common errors: invalid parameters, missing authorization, not found resources, duplicate entities (409), and invalid/expired verification codes.

🏗️ Aquaticus — Projects API Guide

🚀 Quick Start

1) Register

2) Login

3) Verify your email (required for creating clients/projects and running calculations)

Social Login

You can find example flows how to use social login here

4) Create a client ➜ requires verified email

5) Create a project ➜ requires verified email & an existing clientId

6) Calculate from raw variables ➜ requires verified email

7) Calculate for a saved project ➜ requires verified email

8) List projects

🧰 Tools — Temporary Variables API

Endpoints

Get the latest temporary variable set

Save a temporary variables payload

🔐 Authentication & Email Confirmation

📁 Projects API

Endpoints

Delete a project

👥 Clients API

Endpoints

Delete a client

🧮 Calculations

Endpoints

Examples

🧱 ProjectVariables: Fields, Defaults & Validation

👤 Me — User Profile API

Endpoints

Get my profile

Update my profile (partial)

✅ Validation ranges

✅ Validation ranges

⚠️ Notes & errors

5) Create a project ➜ requires verified email & an existing `clientId`