Segments

PreviousBulk NextAppliances

Retrieve all AirTravelSegment

Retreive all AirTravelSegment that belong to a specific AirTravel

get

/air-travel/{air_travel_id}/segments

Path parameters

air_travel_idstringrequired

ID of the AirTravel

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Query parameters

per_pageinteger

limit of records per page

Example: 10

pageinteger

page number

Example: 2

sort_bystring

This parameter is used to sort the records by a specific field (flight_date,flight_number,flight_status,started_at,ended_at,created_at)

Example: type

sort_dirstring

Order type(asc or desc)

Example: asc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://app.greenplaces.com/api/air-travel/{air_travel_id}/segments'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": [
    {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "flight_date": "2023-06-12T17:30:21.000000Z",
      "flight_number": "BA2490",
      "flight_status": "completed",
      "started_at": "2023-06-12T17:30:21.000000Z",
      "ended_at": "2023-06-12T17:30:21.000000Z",
      "aircraft": {},
      "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "distance_mi": "12.2",
      "distance_km": "45.2",
      "emission": null,
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    }
  ],
  "meta": {
    "pagination": {
      "current": "1",
      "last_page": "1",
      "per_page": "10",
      "total": "6"
    }
  }
}

Successful operation

Store an AirTravelSegment

Store an AirTravelSegment to a particular AirTravel

post

/air-travel/{air_travel_id}/segments

Path parameters

air_travel_idstringrequired

ID of the AirTravel

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Body

airline_idanyrequired

Airline ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

flight_dateanyrequired

Flight Date for the airtravel segment

Example: 2023-03-17

flight_numberany

Flight Number for the airtravel segment

Example: BA2490

flight_statusany

Flight Status for the airtravel segment

Example: completed

started_atany

Started At for the airtravel segment

Example: 2023-03-17 12:34:56

ended_atany

Ended At for the airtravel segment

Example: 2023-03-17 13:45:30

aircraftany

Aircraft for the airtravel segment

Example: {}

departure_idanyrequired

Departure ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

arrival_idanyrequired

Arrival ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://app.greenplaces.com/api/air-travel/{air_travel_id}/segments' \
  --header 'Content-Type: application/json' \
  --data '{
    "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "flight_date": "2023-03-17",
    "flight_number": "BA2490",
    "flight_status": "completed",
    "started_at": "2023-03-17 12:34:56",
    "ended_at": "2023-03-17 13:45:30",
    "aircraft": "{}",
    "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469"
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "flight_date": "2023-06-12T17:30:21.000000Z",
    "flight_number": "BA2490",
    "flight_status": "completed",
    "started_at": "2023-06-12T17:30:21.000000Z",
    "ended_at": "2023-06-12T17:30:21.000000Z",
    "aircraft": {},
    "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "distance_mi": "12.2",
    "distance_km": "45.2",
    "emission": null,
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Retrieve an AirTravelSegment

Retrieve an AirTravelSegment that belongs to a particular AirTravel

get

/air-travel/{air_travel_id}/segments/{id}

Path parameters

air_travel_idstringrequired

ID of the AirTravel

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

idstringrequired

ID of the AirTravelSegment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://app.greenplaces.com/api/air-travel/{air_travel_id}/segments/{id}'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "flight_date": "2023-06-12T17:30:21.000000Z",
    "flight_number": "BA2490",
    "flight_status": "completed",
    "started_at": "2023-06-12T17:30:21.000000Z",
    "ended_at": "2023-06-12T17:30:21.000000Z",
    "aircraft": {},
    "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "distance_mi": "12.2",
    "distance_km": "45.2",
    "emission": null,
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Update an AirTravelSegment

Update an AirTravelSegment for a particular AirTravel

put

/air-travel/{air_travel_id}/segments/{id}

Path parameters

air_travel_idstringrequired

ID of the AirTravel

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

idstringrequired

ID of the AirTravelSegment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Body

airline_idanyrequired

Airline ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

flight_dateanyrequired

Flight Date for the airtravel segment

Example: 2023-06-12T17:30:21.000000Z

flight_numberany

Flight Number for the airtravel segment

Example: BA2490

flight_statusany

Flight Status for the airtravel segment

Example: completed

started_atany

Started At for the airtravel segment

Example: 2023-06-12T17:30:21.000000Z

ended_atany

Ended At for the airtravel segment

Example: 2023-06-12T17:30:21.000000Z

aircraftany

Aircraft for the airtravel segment

Example: {}

departure_idanyrequired

Departure ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

arrival_idanyrequired

Arrival ID for the airtravel segment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://app.greenplaces.com/api/air-travel/{air_travel_id}/segments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "flight_date": "2023-06-12T17:30:21.000000Z",
    "flight_number": "BA2490",
    "flight_status": "completed",
    "started_at": "2023-06-12T17:30:21.000000Z",
    "ended_at": "2023-06-12T17:30:21.000000Z",
    "aircraft": "{}",
    "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469"
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "airline_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "flight_date": "2023-06-12T17:30:21.000000Z",
    "flight_number": "BA2490",
    "flight_status": "completed",
    "started_at": "2023-06-12T17:30:21.000000Z",
    "ended_at": "2023-06-12T17:30:21.000000Z",
    "aircraft": {},
    "departure_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "arrival_id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "distance_mi": "12.2",
    "distance_km": "45.2",
    "emission": null,
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Delete an AirTravelSegment

Delete an AirTravelSegment that belongs to a specific AirTravel

delete

/air-travel/{air_travel_id}/segments/{id}

Path parameters

air_travel_idstringrequired

ID of the AirTravel

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

idstringrequired

ID of the AirTravelSegment

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://app.greenplaces.com/api/air-travel/{air_travel_id}/segments/{id}'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": null,
  "meta": {}
}

Successful operation