49 lines
851 B
Markdown
49 lines
851 B
Markdown
# LocationsApi document shapes
|
|
|
|
This service expects JSON request bodies for location creation and updates and
|
|
stores location documents in MongoDB.
|
|
|
|
Inbound JSON documents
|
|
- CreateLocationRequest (`POST /api/locations`)
|
|
```json
|
|
{
|
|
"name": "string",
|
|
"coord": {
|
|
"x": 0,
|
|
"y": 0
|
|
}
|
|
}
|
|
```
|
|
- UpdateLocationRequest (`PUT /api/locations/{id}`)
|
|
```json
|
|
{
|
|
"name": "string"
|
|
}
|
|
```
|
|
`coord` cannot be updated.
|
|
- UpdateLocationPresenceRequest (`POST /api/locations/presence`)
|
|
```json
|
|
{
|
|
"characterId": "string",
|
|
"coord": {
|
|
"x": 0,
|
|
"y": 0
|
|
}
|
|
}
|
|
```
|
|
|
|
Stored documents (MongoDB)
|
|
- Location
|
|
```json
|
|
{
|
|
"id": "string (ObjectId)",
|
|
"name": "string",
|
|
"coord": {
|
|
"x": 0,
|
|
"y": 0
|
|
},
|
|
"characterIds": ["string"],
|
|
"createdUtc": "string (ISO-8601 datetime)"
|
|
}
|
|
```
|