ceyehat-api

My senior project backend

---

Index

• API Definition
  • Users
    • User Registration
      • User Register Request
      • User Register Response
    • User Login
      • User Login Request
      • User Login Response
  • Countries
    • Create Country
      • Create Country Request
      • Create Country Response
  • Cities
    • Create City
      • Create City Request
      • Create City Response
  • Airlines
    • Create Airline
      • Create Airline Request
      • Create Airline Response
  • Airports
    • Create Airport
      • Create Airport Request
      • Create Airport Response
  • Aircrafts
    • Create Aircraft
      • Create Aircraft Request
      • Create Aircraft Response
  • Customers
    • Create Customer
      • Create Customer Request
      • Create Customer Response
  • Flights
    • Create Flight
      • Create Flight Request
      • Create Flight Response
  • Seats
    • Create Seat
      • Create Seat Request
      • Create Seat Response
  • Prices
    • Create Price
      • Create Price Request
      • Create Price Response

---

API Definition

All requests shown here can be found at ceyehat/Requests

User Registration

User Register Request

POST /api/auth/register

{
  "email": "test@github.com",
  "password": "Test12345",
  "firstname": "Github",
  "lastname":"Test"
}

User Register Response

HTTP/1.1 200 OK

{
  "accessToken": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1NzQyMGQwMy1lOGIxLTRjOTctOTFkZC01ZTI3Mjk2YmFlNzEiLCJnaXZlbl9uYW1lIjoiR2l0aHViIiwiZmFtaWx5X25hbWUiOiJUZXN0IiwianRpIjoiODFjOWE1MjctYzdkZC00MTUwLTljNzctZTdhM2FiMzU2ZDc5IiwiZXhwIjoxNjc2ODgyMzg0LCJpc3MiOiJBZGVtQ0xLIiwiYXVkIjoiQWRlbUNMSyJ9.yD0rtDvkOW2Dlh4cDiDEYNoma5KX4CQd1fq2XXZlTCD1FGdFYjzYvPo4JcMffWVrsVj87anJomkSXxaYEwxtVQ",
  "expireDate": "2023-02-20T08:39:44.001838Z",
  "refreshToken": "ce8982d7-5127-4fce-95f2-de9c0229af77"
}

User Login

User Login Request

POST http://localhost:5228/api/auth/login

{
  "email": "test@github.com",
  "password": "Test12345"
}

User Login Response

HTTP/1.1 200 OK

{
  "accessToken": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1NzQyMGQwMy1lOGIxLTRjOTctOTFkZC01ZTI3Mjk2YmFlNzEiLCJnaXZlbl9uYW1lIjoiR2l0aHViIiwiZmFtaWx5X25hbWUiOiJUZXN0IiwianRpIjoiMjA2YzFmZTctNjhiMi00Y2Y5LWE2MzktMzE1ZmRjZTgxNmRmIiwiZXhwIjoxNjc2ODgyOTU0LCJpc3MiOiJBZGVtQ0xLIiwiYXVkIjoiQWRlbUNMSyJ9.bMOqX_ulZSLVmoQr_mbj0D4NGYLv4Sgs3ozuuHQUITUQpqMe5dzjrvcvjV0Kelgb_QHapt7D6cf6GiuuakYZNg",
  "expireDate": "2023-02-20T08:49:14.310414Z",
  "refreshToken": "747a9500-ee48-4279-862b-f983e6b56632"
}

Create Country

Requires authorization token.

Create Country Request

POST /api/Country

{
  "unLocode": "792",
  "name": "Türkiye",
  "iso2": "TR",
  "iso3": "TUR",
  "currency": 15
}

Create Country Response

HTTP/1.1 200 OK

{
  "id": "7afcf68f-2f86-4d20-9f02-72c707b31a29",
  "unLocode": "792",
  "name": "Türkiye",
  "iso2": "TR",
  "iso3": "TUR",
  "currency": 15,
  "aircraftIds": [],
  "airlineIds": [],
  "cityIds": [],
  "createdAt": "2023-02-20T09:14:04.770867Z",
  "updatedAt": "2023-02-20T09:14:04.770867Z"
}

Create City

Requires authorization token.

Create City Request

POST /api/City

{
  "Name": "İstanbul",
  "CountryId": "7afcf68f-2f86-4d20-9f02-72c707b31a29",
  "Districts": [
    {
      "Name": "Pendik",
      "Neighborhoods": [
        {
          "Name": "Sanayi"
        }
      ]
    }
  ]
}

Create City Response

HTTP/1.1 200 OK

{
  "id": "e0b9aab2-e1e1-4fbc-9aa9-10988fc15764",
  "name": "İstanbul",
  "countryId": "7afcf68f-2f86-4d20-9f02-72c707b31a29",
  "districts": [
    {
      "id": "fbaf912a-4e74-4908-9763-5b4fbf80d3ec",
      "name": "Pendik",
      "neighborhoods": [
        {
          "id": "23f03723-7a09-40e3-ba61-e777005de2c8",
          "name": "Sanayi",
          "airlineId": null,
          "airportId": null
        }
      ]
    }
  ],
  "createdAt": "2023-02-20T11:37:33.372649Z",
  "updatedAt": "2023-02-20T11:37:33.372649Z"
}

Create Airline

Requires authorization token.

Create Airline Request

POST /api/Airline

{
  "name": "Turkish Airlines",
  "iataCode": "TK",
  "icaoCode": "THY",
  "callsign": "TURKISH",
  "code": "235",
  "website": "https://www.turkishairlines.com",
  "address": {
    "cityId": "b936bdcc-5bec-4660-b296-682fb142e5c5"
  },
  "aircraftIds": [
    ""
  ]
}

Create Airline Response

HTTP/1.1 200 OK

{
  "id": "09f46ed8-ca89-4d8d-ac67-d2fb4b9200b6",
  "name": "Turkish Airlines",
  "iataCode": "TK",
  "icaoCode": "THY",
  "callsign": "TURKISH",
  "code": "235",
  "website": "https://www.turkishairlines.com",
  "address": {
    "city": "b936bdcc-5bec-4660-b296-682fb142e5c5"
  },
  "aircraftIds": [],
  "createdAt": "2023-02-20T18:58:00.195811Z",
  "updatedAt": "2023-02-20T18:58:00.195811Z"
}

Create Airport

Requires authorization token.

Create Airport Request

POST /api/Airport

{
  "name": "Sabiha Gökçen Uluslararası Havalimanı",
  "cityId": "b936bdcc-5bec-4660-b296-682fb142e5c5",
  "iataCode": "SAW",
  "icaoCode": "LTFJ",
  "latitude": 40.9054302267176,
  "longitude": 29.31685227451326,
  "timezone": "GMT+03:00"
}

Create Airport Response

HTTP/1.1 200 OK

{
  "id": "36c66a4f-dc74-4c70-8823-e02583cfe285",
  "name": "Sabiha Gökçen Uluslararası Havalimanı",
  "cityId": "b936bdcc-5bec-4660-b296-682fb142e5c5",
  "iataCode": "SAW",
  "icaoCode": "LTFJ",
  "latitude": 40.9054302267176,
  "longitude": 29.31685227451326,
  "timezone": "GMT+03:00",
  "departureFlights": [],
  "arrivalFlights": [],
  "createdAt": "2023-02-20T21:14:49.184471Z",
  "updatedAt": "2023-02-20T21:14:49.184471Z"
}

Create Aircraft

Requires authorization token.

Create Aircraft Request

POST /api/Aircraft

{
  "registrationNumber": "TC-JFE",
  "icao24Code": "4BA8C5",
  "model": "Boeing 737-8F2",
  "manufacturerSerialNumber": "29767",
  "faaRegistration": "N1786B",
  "countryId" : "7afcf68f-2f86-4d20-9f02-72c707b31a29",
  "airlineId" : "09f46ed8-ca89-4d8d-ac67-d2fb4b9200b6"
}

Create Aircraft Response

HTTP/1.1 200 OK

{
  "id": "0a3901f2-cf62-441e-9ae8-0d3a9e5059c2",
  "registrationNumber": "TC-JFE",
  "icao24Code": "4BA8C5",
  "model": "Boeing 737-8F2",
  "manufacturerSerialNumber": "29767",
  "faaRegistration": "N1786B",
  "countryId": "7afcf68f-2f86-4d20-9f02-72c707b31a29",
  "airlineId": "09f46ed8-ca89-4d8d-ac67-d2fb4b9200b6",
  "flightIds": [],
  "seatIds": [],
  "createdAt": "2023-02-21T10:11:29.506748Z",
  "updatedAt": "2023-02-21T10:11:29.506748Z"
}

Create Customer

Requires authorization token.

Create Customer Request

POST /api/Customer

{
  "name": "Test",
  "surname": "Customer",
  "email": "test@customer.com",
  "phoneNumber": "0000001111",
  "title": 0,
  "birthDate": "2023-02-21T13:18:27.199Z",
  "passengerType": 0,
  "userId": null
}

Create Customer Response

HTTP/1.1 200 OK

{
  "id": "baff9e0e-c670-4ab2-92b1-207af6f81288",
  "name": "Test",
  "surname": "Customer",
  "email": "test@customer.com",
  "phoneNumber": "0000001111",
  "title": 0,
  "birthDate": "2023-02-21T13:18:27.199Z",
  "passengerType": 0,
  "userId": "77d7e6a0-7f21-4583-b572-bd62e862115f",
  "bookings": [],
  "flightTickets": [],
  "boardingPasses": [],
  "createdAt": "2023-02-21T13:34:07.561229Z",
  "updatedAt": "2023-02-21T13:34:07.561229Z"
}

Create Flight

Requires authorization token.

Create Flight Request

POST /api/Flight

{
  "flightNumber": "AI000001",
  "scheduledDeparture": "2023-02-21T16:13:34.240Z",
  "scheduledArrival": "2023-02-21T16:13:34.240Z",
  "status": 0,
  "type": 0,
  "actualDeparture": null,
  "actualArrival": null,
  "aircraftId": "0a3901f2-cf62-441e-9ae8-0d3a9e5059c2",
  "departureAirportId": "f0b4f0f9-496f-4a9f-a60e-bfc63eb91f04",
  "arrivalAirportId": "a5cf68f9-23a3-4385-8bcb-bbd586a4d23b",
  "priceId": "f0b4f0f9-496f-4a9f-a60e-bfc63eb91f04"
}

Create Flight Response

HTTP/1.1 200 OK

{
  "id": "b50106b5-5dc1-4c53-9f07-aab7dd253d18",
  "flightNumber": "AI000001",
  "scheduledDeparture": "2023-02-21T16:13:34.24Z",
  "scheduledArrival": "2023-02-21T16:13:34.24Z",
  "status": "Scheduled",
  "type": "RoundTrip",
  "actualDeparture": null,
  "actualArrival": null,
  "aircraftId": "0a3901f2-cf62-441e-9ae8-0d3a9e5059c2",
  "departureAirportId": "f0b4f0f9-496f-4a9f-a60e-bfc63eb91f04",
  "arrivalAirportId": "a5cf68f9-23a3-4385-8bcb-bbd586a4d23b",
  "priceId": "f0b4f0f9-496f-4a9f-a60e-bfc63eb91f04",
  "createdAt": "2023-02-21T20:55:27.113222Z",
  "updatedAt": "2023-02-21T20:55:27.113222Z"
}

Create Seat

Requires authorization token.

Create Seat Request

POST /api/Seat

{
  "seatNumber": "A1",
  "aircraftId": "0a3901f2-cf62-441e-9ae8-0d3a9e5059c2",
  "seatClass": 0,
  "seatStatus": 0
}

Create Seat Response

HTTP/1.1 200 OK

{
  "id": "876898a7-474d-433f-ac14-aad2fea9c264",
  "seatNumber": "A1",
  "seatClass": "Economy",
  "seatStatus": "Available",
  "aircraftId": "0a3901f2-cf62-441e-9ae8-0d3a9e5059c2",
  "createdAt": "2023-02-21T21:19:32.814403Z",
  "updatedAt": "2023-02-21T21:19:32.814404Z"
}

Create Price

Requires authorization token.

Create Price Request

POST /api/Price

{
  "amount": 1,
  "currency": 0,
  "pricing": {
    "baseCost": 100,
    "markupPercentage": 10,
    "demandMultiplier": 1,
    "competitionMultiplier": 0.9,
    "seasonalMultiplier": 1.3,
    "lengthMultiplier": 1.5,
    "classMultiplier": 1.2
  }
}

Create Price Response

HTTP/1.1 200 OK

{
  "id": "4879b856-be8a-4593-a772-2350663dbae3",
  "amount": 1,
  "currency": "Usd",
  "pricing": {
    "baseCost": 100,
    "markupPercentage": 10,
    "demandMultiplier": 1,
    "competitionMultiplier": 0.9,
    "seasonalMultiplier": 1.3,
    "lengthMultiplier": 1.5,
    "classMultiplier": 1.2,
    "totalCost": 2316.6000
  },
  "createdAt": "2023-02-21T21:58:39.588187Z",
  "updatedAt": "2023-02-21T21:58:39.588187Z"
}

Disclaimer

This is an educational project.

License

This project is licensed under the MIT License