Basic CRUD Operations

The basic CRUD (Create, Read, Update, Delete) interfaces are the core capabilities of the entity management service.

1. Create (Create)

Create a new entity resource.

• URL: /api/app/{entity-name}
• Method: POST
• Request Body: DTO object of the entity (e.g., CreateUserDto)

{
  "userName": "johndoe",
  "email": "[email protected]",
  "isActive": true
}

• Response: The created entity DTO.

2. Read (Get/GetList)

Get Single Entity

• URL: /api/app/{entity-name}/{id}
• Method: GET
• Response: Entity DTO.

Get List (Pagination & Filtering)

• URL: /api/app/{entity-name}
• Method: GET
• Parameters:
  • SkipCount: Number of records to skip (for pagination).
  • MaxResultCount: Maximum number of records to return per page.
  • Sorting: Sorting field (e.g., CreationTime desc).
  • Filter: Keyword search.

3. Update (Update)

Update an existing entity.

• URL: /api/app/{entity-name}/{id}
• Method: PUT
• Request Body: Update DTO (e.g., UpdateUserDto).

4. Delete (Delete)

Delete an entity.

• URL: /api/app/{entity-name}/{id}
• Method: DELETE
• Response: 204 No Content.