Skip to content

Location Service

Sjors Scholten edited this page Jun 3, 2021 · 3 revisions

Location Service Model

Location service consists out of 3 domain models: Building, City, and Room.

  1. A City is a place where a Building is settled.
  2. A Building is a real building or campus of fontys. a Building has an address object with delivery details
  3. A Room is a collection point the package needs to be delivered to.

Interfaces

City

Naam Methode Endpoint
CreateCity POST /
GetAllCities GET /
GetCityById GET /{id}
GetCityByName GET /name/{name}
UpdateCity UPDATE /{id}
DeleteCityById DELETE /{id}
  • CreateCity: Creates a new City using data in the attached CityRequest, returns the city data in a CityRepsonse.
  • GetAllCities: Returns a collection of CityResponses.
  • GetCityById: Returns a CityResponse with the corresponding Id.
  • GetCityByName: returns a CityResponse with the corresponding name.
  • UpdateCity: Update the city with the corresponding id with the data in the attached CityRequest, returns a CityResponse with the data of the updated city;
  • DeleteCityById: Disable the City with the corresponding Id.

Building

Naam Methode Endpoint
CreateBuilding POST /
GetAllBuildings GET /
GetBuildingById GET /{id}
GetBuildingByName GET /name/{name}
UpdateBuilding UPDATE /{id}
DeleteBuildingById DELETE /{id}
  • CreateBuilding: Creates a new Building using data in the attached BuildingRequest, returns the Building data in a BuildingRepsonse.
  • GetAllBuildings: Returns a collection of BuildingResponses.
  • GetBuildingById: Returns a BuildingResponse with the corresponding Id.
  • GetBuildingByName: returns a BuildingResponse with the corresponding name.
  • UpdateBuilding: Update the Building with the corresponding id with the data in the attached BuildingRequest, returns a BuildingResponse with the data of the updated Building;
  • DeleteBuildingById: Disable the Building with the corresponding Id.

Room

Naam Methode Endpoint
CreateRoom POST /
GetAllRooms GET /
GetRoomById GET /{id}
GetRoomByName GET /name/{name}
UpdateRoom UPDATE /{id}
DeleteRoomById DELETE /{id}
  • CreateRoom: Creates a new Room using data in the attached RoomRequest, returns the Room data in a RoomRepsonse.
  • GetAllRooms: Returns a collection of RoomResponses.
  • GetRoomById: Returns a RoomResponse with the corresponding Id.
  • GetRoomByName: returns a RoomResponse with the corresponding name.
  • UpdateRoom: Update the Room with the corresponding id with the data in the attached RoomRequest, returns a RoomResponse with the data of the updated Room;
  • DeleteRoomById: Disable the Room with the corresponding Id.
Clone this wiki locally