Web Service

Facilities

• The REST Web Service implements endpoints for
  • Authenticating registered users
  • Adding, updating and retrieving details for:
    • Aircraft
    • Airlines
    • Airports and their host countries
    • Flights
    • Locations
    • Manufacturers and the aircraft models they produce
    • Aircraft sightings
  • Looking up flights, aircraft and airports via the external APIs
  • Generating reports and exporting them in CSV format
  • Exporting sightings and airport lists in CSV format
• Swagger documentation is exposed at:

/swagger/index.html

• For full details of the service endpoints, it's recommended to build and run the service and review the documentation exposed at the above URL

Configuration

• The web service uses an "appsettings.json" file to hold configuration settings
• It's described in the "Application Configuration File" section

Authentication

• The service uses bearer token authentication, so clients should:
  • Use the /users/authenticate endpoint to get a token
  • Set the authorization header in subsequent requests:

Authorization: Bearer <token>

Database Users

• To authenticate, users must have a record in the USER table of the database associating a username with their hashed password
• Details on how to create a user are given in the section on the "Command Line Tool"