@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Safe Place
@base https://test.api.amadeus.com/v1
@version 1.0.1
@endpoints 3
@toc safety(3)

@endpoint GET /safety/safety-rated-locations
@desc Returns safety rating for a given location and radius.
@required {latitude: any # Latitude (decimal coordinates), longitude: any # Longitude (decimal coordinates)}
@optional {radius: any # radius of the search in Kilometer. Can be from 0 to 20, default value is 1 Km., page[limit]: any # maximum items in one page, page[offset]: any # start index of the requested page}
@returns(200) Successful Operation
@errors {400: code    | title                                  ------- | -------------------------------------  477     | INVALID FORMAT 572     | INVALID OPTION 4926    | INVALID DATA RECEIVED                32171   | MANDATORY DATA MISSING}

@endpoint GET /safety/safety-rated-locations/{safety-rated-locationId}
@desc Retieve safety information of a location by its Id.
@returns(200) Successful Operation
@errors {400: code    | title                                  ------- | -------------------------------------  477     | INVALID FORMAT 572     | INVALID OPTION 4926    | INVALID DATA RECEIVED                32171   | MANDATORY DATA MISSING, 404: Not Found}

@endpoint GET /safety/safety-rated-locations/by-square
@desc Returns the safety rating of a given area
@required {north: any # Latitude north of bounding box (decimal coordinates), west: any # Longitude west of bounding box (decimal coordinates), south: any # Latitude south of bounding box (decimal coordinates), east: any # Longitude east of bounding box (decimal coordinates)}
@optional {page[limit]: any # maximum items in one page, page[offset]: any # start index of the requested page}
@returns(200) Successful Operation
@errors {400: code    | title                                  ------- | -------------------------------------  477     | INVALID FORMAT 572     | INVALID OPTION 4926    | INVALID DATA RECEIVED                32171   | MANDATORY DATA MISSING}

@end
