71 lines
1.5 KiB
Markdown
71 lines
1.5 KiB
Markdown
# `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)
|
|
|
|
| Field | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `addressType` | yes | string | |
|
|
| `firstName` | no | string | |
|
|
| `name` | no | string | |
|
|
| `street` | no | string | |
|
|
| `streetNumber` | no | string | |
|
|
| `zip` | no | string | |
|
|
| `city` | no | string | |
|
|
| `county` | no | string | |
|
|
|
|
```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`._
|