Skip to content
MyCareConnect For Developer

Data CRUD

The Entity CRUD (Create, Read, Update, Delete) API is a set of RESTful endpoints designed to perform basic operations onthe entities within the MyCareConnect platform.

Caregory is the product name. it can be one of the following:

  • carewait
  • carecontrol
  • careconnect

The previous version used appdata as the category. It is deprecated and will be removed in the future.

Entity please see Entity Model List

These APIs are structured to handle specific tasks related to each entity type, providing a straightforward way to manage data programmatically. The detail please see API Document, Below are the primary methods:

Create (POST)

Section titled “Create (POST)”
Create
POST /{Category}/{Entity}/create;

This endpoint is used to create a new record of the specified entity. The data for the new entity is provided in the request body.

Update (PUT)

Section titled “Update (PUT)”
Update By ID
PUT /{Category}/{Entity}/update/:id;

Updates an existing entity record identified by its unique ID. The updated data is sent in the request body.

Retrieve (GET)

Section titled “Retrieve (GET)”
Retrieve By ID
GET /{Category}/{Entity}/retrieve/:id;

Retrieves the details of a specific entity record using its unique ID.

Delete (DELETE)

Section titled “Delete (DELETE)”
Delete By ID
DELETE /{Category}/{Entity}/delete/:id;

Deletes a specific entity record identified by its unique ID.

Additionally, there are more complex operations that use the POST method:

Update By Filter (POST)

Section titled “Update By Filter (POST)”
Terminal window
POST /{Category}/{Entity}/update;

Allows for updating one record based on a set of conditions specified in the ‘filter’ parameter.

Delete By Filter (POST)

Section titled “Delete By Filter (POST)”
Terminal window
POST /{Category}/{Entity}/delete;

Delete one record that meet certain conditions defined in the ‘filter’ parameter.

Retrieve By Filter (POST)

Section titled “Retrieve By Filter (POST)”
Terminal window
POST /{Category}/{Entity}/retrieve;

Retrieves a unique record that matches the specified conditions in the ‘filter’ parameter.

The retrieve method is specifically designed for fetching single records.

For queries that require retrieving multiple records based on various criteria, the Query Data API should be used. This API is particularly effective for more complex data retrieval scenarios where specific filtering, sorting, and pagination may be necessary.