Update doc

This commit is contained in:
Kouril42 2023-02-22 19:13:34 +01:00
parent 9cee47b80a
commit 4a0ad498d8

31
API.md
View File

@ -26,6 +26,13 @@ __The dict looks like :__
'names' : string[], //Names of the place, possibly empty,
'type': string, //in {'C'(orridor), 'S'(tairs), 'E'(levator), 'R'(oom)} ,
'surface' : list of [int, int] //list of every points composing the room, projected on the floor surface
'connectedFloors' : [
{
'id' : int,
'name' : string
},
{...}
]
},
{...}
]
@ -191,6 +198,30 @@ __Errors :__
- If _ID_ doesn't correspond to any registered edition : Return Error 404 "NotFoundHttpError".
- If _ID_ has many occurence in the EditionRepository : Return Error 500 > The Database is corrupted.
---------------------
### /api/map/get_site_name/ID
> Return the name of a site ID
__Errors :__
- If _ID_ doesn't correspond to any registered site : Return Error 404 "NotFoundHttpError".
- If _ID_ has many occurence in the EditionRepository : Return Error 500 > The Database is corrupted.
---------------------
### /api/map/get_building_name/ID
> Return the name of a building ID
__Errors :__
- If _ID_ doesn't correspond to any registered building : Return Error 404 "NotFoundHttpError".
- If _ID_ has many occurence in the EditionRepository : Return Error 500 > The Database is corrupted.
---------------------
### /api/map/get_floor_name/ID
> Return the name of a floor ID
__Errors :__
- If _ID_ doesn't correspond to any registered floor : Return Error 404 "NotFoundHttpError".
- If _ID_ has many occurence in the EditionRepository : Return Error 500 > The Database is corrupted.
---------------------
### /api/map/del_place_name/PLACEID/NAME
> Remove _NAME_ from the place _PLACEID_.