Add customergroup and entity HTTP APIs with address and contact routes.
Expose store-backed CRUD for customer groups, entities, nested addresses, and contacts, matching the documented dashdbschema contracts.
This commit is contained in:
49
docs/api/routes/entity/address/list.md
Normal file
49
docs/api/routes/entity/address/list.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# `GET /entity/{entityId}/address`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List entity addresses
|
||||
|
||||
Lists addresses for an entity of the selected company.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `entityId` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Address list
|
||||
|
||||
```json
|
||||
{
|
||||
"addresses": [
|
||||
{
|
||||
"id": 1,
|
||||
"entityId": 1,
|
||||
"firstName": "…",
|
||||
"name": "…",
|
||||
"street": "…",
|
||||
"streetNumber": "…",
|
||||
"zip": "…",
|
||||
"city": "…",
|
||||
"county": "…",
|
||||
"addressType": "…"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected or invalid entityId — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Entity or company not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user