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:
59
docs/api/routes/entity/address/create.md
Normal file
59
docs/api/routes/entity/address/create.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# `POST /entity/{entityId}/address`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create entity address
|
||||
|
||||
Creates an address for the entity. `addressType` is required.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `entityId` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"addressType": "billing",
|
||||
"street": "Hauptstraße",
|
||||
"streetNumber": "12",
|
||||
"zip": "10115",
|
||||
"city": "Berlin"
|
||||
}
|
||||
```
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created address
|
||||
|
||||
```json
|
||||
{
|
||||
"address": {
|
||||
"id": 1,
|
||||
"entityId": 1,
|
||||
"firstName": "…",
|
||||
"name": "…",
|
||||
"street": "…",
|
||||
"streetNumber": "…",
|
||||
"zip": "…",
|
||||
"city": "…",
|
||||
"county": "…",
|
||||
"addressType": "…"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Address type required, invalid entityId, or no company selected — `{"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