promiscuity/microservices/LocationsApi/DOCUMENTS.md

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)

  {
    "name": "string",
    "coord": {
      "x": 0,
      "y": 0
    }
  }
  

• UpdateLocationRequest (PUT /api/locations/{id})

  {
    "name": "string"
  }
  

  coord cannot be updated.
• UpdateLocationPresenceRequest (POST /api/locations/presence)

  {
    "characterId": "string",
    "coord": {
      "x": 0,
      "y": 0
    }
  }
  

Stored documents (MongoDB)

• Location

  {
    "id": "string (ObjectId)",
    "name": "string",
    "coord": {
      "x": 0,
      "y": 0
    },
    "characterIds": ["string"],
    "createdUtc": "string (ISO-8601 datetime)"
  }