LodgeManager Backend Documentation

Here's a list of all the URL Paths you can use with this backend and what each URL Path does.

Buildings, Rooms, Services

• GET /api/toa-nha
• POST /api/toa-nha
• GET /api/toa-nha/:id
• PUT /api/toa-nha/:id
• DELETE /api/toa-nha/:id
• GET /api/toa-nha/search
• GET /api/toa-nha/:id/phong

Rooms

• GET /api/phong
• POST /api/phong
• GET /api/phong/:id
• PUT /api/phong/:id
• DELETE /api/phong/:id
• GET /api/phong/search
• GET /api/phong/:id/hop-dong
• GET /api/phong/:id/hoa-don

Customers, Contracts

• GET /api/khach-hang
• POST /api/khach-hang
• GET /api/khach-hang/:id
• PUT /api/khach-hang/:id
• DELETE /api/khach-hang/:id
• GET /api/khach-hang/search
• GET /api/khach-hang/:id/hop-dong
• GET /api/hop-dong
• POST /api/hop-dong
• GET /api/hop-dong/:id
• PUT /api/hop-dong/:id
• DELETE /api/hop-dong/:id
• GET /api/hop-dong/search
• GET /api/hop-dong/:id/hoa-don

Invoices, Documents, Reports

• GET /api/hoa-don
• POST /api/hoa-don
• GET /api/hoa-don/:id
• PUT /api/hoa-don/:id
• DELETE /api/hoa-don/:id
• GET /api/hoa-don/search
• POST /api/hoa-don/:id/thanh-toan
• GET /api/giay-to
• POST /api/giay-to
• GET /api/giay-to/:id
• PUT /api/giay-to/:id
• DELETE /api/giay-to/:id
• GET /api/giay-to/search
• POST /api/giay-to/upload
• GET /api/giay-to/:id/download
• GET /api/bao-cao
• POST /api/bao-cao
• GET /api/bao-cao/:id
• PUT /api/bao-cao/:id
• DELETE /api/bao-cao/:id
• GET /api/bao-cao/search
• POST /api/bao-cao/upload
• GET /api/bao-cao/:id/download

Owners, Test

• GET /api/chu-nha
• POST /api/chu-nha
• GET /api/chu-nha/:id
• PUT /api/chu-nha/:id
• DELETE /api/chu-nha/:id
• GET /api/chu-nha/search
• GET /api/test
• GET /api/ping
• POST /api/logout

GET /api/toa-nha

Returns a list of buildings.

Response:

[
	{
		id: "number",
		name: "string",
	},
];

POST /api/toa-nha

Creates a new building.

Request:

{
  "name": "string"
}

Response:

{
  "id": "number",
  "name": "string"
}

GET /api/toa-nha/:id

Returns a single building.

URL Parameters:

• id: building id

Response:

{
  "id": "number",
  "name": "string"
}

PUT /api/toa-nha/:id

Updates a building.

URL Parameters:

• id: building id

Request:

{
  "name": "string"
}

Response:

{
  "id": "number",
  "name": "string"
}

DELETE /api/toa-nha/:id

Deletes a building.

URL Parameters:

• id: building id

Response:

• Status: 204 No Response

GET /api/toa-nha/search

Returns buildings that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

Response:

[
	{
		id: "number",
		name: "string",
	},
];

GET /api/toa-nha/:id/phong

Returns rooms inside one building.

URL Parameters:

• id: building id

Response:

[
	{
		id: "number",
		name: "string",
	},
];

GET /api/phong

Returns a list of rooms.

Response:

[
	{
		id: "number",
		name: "string",
	},
];

POST /api/phong

Creates a new room.

Request:

{
  "name": "string"
}

Response:

{
  "id": "number",
  "name": "string"
}

GET /api/phong/:id

Returns a single room.

URL Parameters:

• id: room id

Response:

{
  "id": "number",
  "name": "string"
}

PUT /api/phong/:id

Updates a room.

URL Parameters:

• id: room id

Request:

{
  "name": "string"
}

DELETE /api/phong/:id

Deletes a room.

URL Parameters:

• id: room id

Response:

• Status: 204 No Response

GET /api/phong/search

Returns rooms that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

GET /api/phong/:id/hop-dong

Returns contracts for one room.

URL Parameters:

• id: room id

GET /api/phong/:id/hoa-don

Returns invoices for one room.

URL Parameters:

• id: room id

GET /api/khach-hang

Returns a list of customers.

POST /api/khach-hang

Creates a new customer.

GET /api/khach-hang/:id

Returns a single customer.

URL Parameters:

• id: customer id

PUT /api/khach-hang/:id

Updates a customer.

URL Parameters:

• id: customer id

DELETE /api/khach-hang/:id

Deletes a customer.

URL Parameters:

• id: customer id

GET /api/khach-hang/search

Returns customers that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

GET /api/khach-hang/:id/hop-dong

Returns contracts for one customer.

URL Parameters:

• id: customer id

GET /api/hop-dong

Returns a list of contracts.

POST /api/hop-dong

Creates a new contract.

GET /api/hop-dong/:id

Returns a single contract.

URL Parameters:

• id: contract id

PUT /api/hop-dong/:id

Updates a contract.

URL Parameters:

• id: contract id

DELETE /api/hop-dong/:id

Deletes a contract.

URL Parameters:

• id: contract id

GET /api/hop-dong/search

Returns contracts that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

GET /api/hop-dong/:id/hoa-don

Returns invoices for one contract.

URL Parameters:

• id: contract id

GET /api/hoa-don

Returns a list of invoices.

POST /api/hoa-don

Creates a new invoice.

GET /api/hoa-don/:id

Returns a single invoice.

URL Parameters:

• id: invoice id

PUT /api/hoa-don/:id

Updates an invoice.

URL Parameters:

• id: invoice id

DELETE /api/hoa-don/:id

Deletes an invoice.

URL Parameters:

• id: invoice id

GET /api/hoa-don/search

Returns invoices that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

POST /api/hoa-don/:id/thanh-toan

Marks an invoice as paid.

URL Parameters:

• id: invoice id

GET /api/giay-to

Returns a list of documents.

POST /api/giay-to

Creates a new document record.

GET /api/giay-to/:id

Returns a single document.

URL Parameters:

• id: document id

PUT /api/giay-to/:id

Updates a document.

URL Parameters:

• id: document id

DELETE /api/giay-to/:id

Deletes a document.

URL Parameters:

• id: document id

GET /api/giay-to/search

Returns documents that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

POST /api/giay-to/upload

Uploads a file.

GET /api/giay-to/:id/download

Downloads a file.

URL Parameters:

• id: document id

GET /api/bao-cao

Returns a list of reports.

POST /api/bao-cao

Creates a new report.

GET /api/bao-cao/:id

Returns a single report.

URL Parameters:

• id: report id

PUT /api/bao-cao/:id

Updates a report.

URL Parameters:

• id: report id

DELETE /api/bao-cao/:id

Deletes a report.

URL Parameters:

• id: report id

GET /api/bao-cao/search

Returns reports that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

POST /api/bao-cao/upload

Uploads a report file.

GET /api/bao-cao/:id/download

Downloads a report file.

URL Parameters:

• id: report id

GET /api/chu-nha

Returns a list of owners.

POST /api/chu-nha

Creates a new owner.

GET /api/chu-nha/:id

Returns a single owner.

URL Parameters:

• id: owner id

PUT /api/chu-nha/:id

Updates an owner.

URL Parameters:

• id: owner id

DELETE /api/chu-nha/:id

Deletes an owner.

URL Parameters:

• id: owner id

GET /api/chu-nha/search

Returns owners that match the search keyword.

Query Parameters:

• q=... (optional): search keyword

GET /api/test

Returns a simple test response.

GET /api/ping

Returns a simple connection check response.

POST /api/logout

Logs out the current user.