Note APIs
This set of APIs manages the full lifecycle of a “Note” resource. Each API plays a specific role, and together they provide a standard create–read–update pattern.
1. Create Note API
POST /note
This endpoint is responsible for creating a new note in the system.
Operation:
- The authenticated client sends note details in the request body.
- The server validates and stores the new note.
- A unique note id is generated and returned in the response.
Typical Response (201 Created):
{
"id": "uuid string",
"createdDate": "UTC time"
...
}Purpose:
- Initialize a fresh note record.
- Retrieve the ID required for further operations (retrieval, updates).
2. Retrieve Note API
GET /note/:id
This endpoint is used to fetch an existing note by its ID.
Operation:
- Client sends a GET request with the id returned from the create step.
- The server validates the ID and returns the note details.
Typical Response (200 OK):
{
"id": "uuid string",
"createdDate": "UTC time"
...
}Purpose:
- View existing profile information.
- Confirm data that was created or previously updated.
3. Update Note API
PUT /note/:id or PATCH /note/:id
These endpoints allow modifying an existing profile.
- PUT: replaces the entire profile record with the new payload.
- PATCH: applies a partial update, only modifying provided fields.
Operation:
- Client sends updated fields with the correct id.
- Server applies the update and returns the updated record or status.
Typical Response (200 OK):
{
"id": "12345",
"createdDate": "UTC time",
...
}Purpose:
- Modify or correct profile information.
- Progress the profile through its lifecycle.
How They Work Together
- Create a note using POST /note.
- Server returns an id.
- Use this ID to either:
- Retrieve the profile (GET /note/:id)
- Update the profile (PUT/PATCH /note/:id)
This flow ensures all note operations are securely tied to an authenticated session, and that each note is managed consistently using its unique identifier.
