Air travel

PreviousAPI Reference NextBulk

Last updated 1 year ago

Retrieve all AirTravelSegment

Retrieve all AirTravelSegment that belong to a company

get

/air-travel

Query parameters

per_pageinteger

limit of records per page

Example: 10

pageinteger

page number

Example: 2

traveler_namestring

This field is used to filter by air-travel name. (LIKE)

Example: test name

currencystring

This field is used to filter by air-travel currency.

Example: USD

sort_bystring

This parameter is used to sort the records by a specific field (created_at,traveler_name)

Example: traveler_name

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'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": [
    {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "traveler_name": "test name",
      "traveler_email": "test@gmail.com",
      "spend_amount": "2000.32",
      "distance_mi": "9164",
      "distance_km": "14745",
      "currency": "USD",
      "segments": [
        {
          "id": "99b80a01-fd16-4c8a-9716-db37407bdc67",
          "started_at": "2023-06-12 17:30:21",
          "ended_at": "2023-06-12 17:30:21",
          "flight_date": "2023-06-12",
          "flight_status": "Completed",
          "flight_number": "A121312",
          "distance_mi": "9164",
          "distance_km": "14745",
          "departure": {
            "id": "36616115-61ba-4890-a6ce-ddb4e4e68ec4",
            "iata_code": "ATD",
            "icao_code": "AGAT",
            "airport_name": "Atoifi"
          },
          "arrival": {
            "id": "300a8ec20-ad3b-4377-a003-0baa23deae3e",
            "iata_code": "ERM",
            "icao_code": "SSER",
            "airport_name": "Comandante Kraemer"
          },
          "airline": {
            "id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
            "iata_code": "7P",
            "icao_code": "PST",
            "airline_name": "Air Panama dba Parsa, S.A."
          },
          "emission": {
            "scope": "3",
            "carbon_equivalent": "6573.6700",
            "carbon_dioxide": "2641.0894",
            "methane": "0.1460",
            "nitrous_oxide": "13.1397"
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "current": "1",
      "last_page": "1",
      "per_page": "10",
      "total": "6"
    }
  }
}

Successful operation

Store an AirTravel

Store an AirTravel for a particular compny.

post

/air-travel

Body

traveler_namestring

name of the air-travel

Example: test name

traveler_emailstring

traveler_email of the air-travel

Example: test@gmail.com

spend_amountnumber

spend_amount of the air-travel

Example: 2000.32

currencystring

currency of the air-travel, by default is USD

Example: USD

segmentsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://app.greenplaces.com/api/air-travel' \
  --header 'Content-Type: application/json' \
  --data '{
    "traveler_name": "test name",
    "traveler_email": "test@gmail.com",
    "spend_amount": "2000.32",
    "currency": "USD",
    "segments": [
      {
        "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
        "flight_date": "2023-03-17",
        "flight_number": "A1212",
        "flight_status": "completed",
        "departure_id": "AGAT",
        "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee",
        "started_at": "2023-03-17 12:34:56",
        "ended_at": "2023-03-17 13:45:30"
      }
    ]
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "traveler_name": "test name",
    "traveler_email": "test@gmail.com",
    "spend_amount": "2000.32",
    "distance_mi": "9164",
    "distance_km": "14745",
    "currency": "USD",
    "segments": [
      {
        "id": "99b80a01-fd16-4c8a-9716-db37407bdc67",
        "started_at": "2023-06-12 17:30:21",
        "ended_at": "2023-06-12 17:30:21",
        "flight_date": "2023-06-12",
        "flight_status": "Completed",
        "flight_number": "A121312",
        "distance_mi": "9164",
        "distance_km": "14745",
        "departure": {
          "id": "36616115-61ba-4890-a6ce-ddb4e4e68ec4",
          "iata_code": "ATD",
          "icao_code": "AGAT",
          "airport_name": "Atoifi"
        },
        "arrival": {
          "id": "300a8ec20-ad3b-4377-a003-0baa23deae3e",
          "iata_code": "ERM",
          "icao_code": "SSER",
          "airport_name": "Comandante Kraemer"
        },
        "airline": {
          "id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
          "iata_code": "7P",
          "icao_code": "PST",
          "airline_name": "Air Panama dba Parsa, S.A."
        },
        "emission": {
          "scope": "3",
          "carbon_equivalent": "6573.6700",
          "carbon_dioxide": "2641.0894",
          "methane": "0.1460",
          "nitrous_oxide": "13.1397"
        }
      }
    ]
  },
  "meta": {}
}

Successful operation

Get air-travel

obtain information about a air-travel

get

/air-travel/{id}

Path parameters

idstringrequired

ID of The AirTravel

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "traveler_name": "test name",
    "traveler_email": "test@gmail.com",
    "spend_amount": "2000.32",
    "distance_mi": "9164",
    "distance_km": "14745",
    "currency": "USD",
    "segments": [
      {
        "id": "99b80a01-fd16-4c8a-9716-db37407bdc67",
        "started_at": "2023-06-12 17:30:21",
        "ended_at": "2023-06-12 17:30:21",
        "flight_date": "2023-06-12",
        "flight_status": "Completed",
        "flight_number": "A121312",
        "distance_mi": "9164",
        "distance_km": "14745",
        "departure": {
          "id": "36616115-61ba-4890-a6ce-ddb4e4e68ec4",
          "iata_code": "ATD",
          "icao_code": "AGAT",
          "airport_name": "Atoifi"
        },
        "arrival": {
          "id": "300a8ec20-ad3b-4377-a003-0baa23deae3e",
          "iata_code": "ERM",
          "icao_code": "SSER",
          "airport_name": "Comandante Kraemer"
        },
        "airline": {
          "id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
          "iata_code": "7P",
          "icao_code": "PST",
          "airline_name": "Air Panama dba Parsa, S.A."
        },
        "emission": {
          "scope": "3",
          "carbon_equivalent": "6573.6700",
          "carbon_dioxide": "2641.0894",
          "methane": "0.1460",
          "nitrous_oxide": "13.1397"
        }
      }
    ]
  },
  "meta": {}
}

Successful operation

Update AirTravel

Update an AirTravel for a company

put

/air-travel/{id}

Path parameters

idstringrequired

ID of The AirTravel

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

Body

traveler_namestring

name of the air-travel

Example: test name

traveler_emailstring

traveler_email of the air-travel

Example: test@gmail.com

spend_amountnumber

spend_amount of the air-travel

Example: 2000.32

currencystring

currency of the air-travel, by default is USD

Example: USD

segmentsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://app.greenplaces.com/api/air-travel/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "traveler_name": "test name",
    "traveler_email": "test@gmail.com",
    "spend_amount": "2000.32",
    "currency": "USD",
    "segments": [
      {
        "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
        "flight_date": "2023-03-17",
        "flight_number": "A1212",
        "flight_status": "completed",
        "departure_id": "AGAT",
        "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee",
        "started_at": "2023-03-17 12:34:56",
        "ended_at": "2023-03-17 13:45:30"
      }
    ]
  }'

200

400

403

404

500

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "traveler_name": "test name",
    "traveler_email": "test@gmail.com",
    "spend_amount": "2000.32",
    "distance_mi": "9164",
    "distance_km": "14745",
    "currency": "USD",
    "segments": [
      {
        "id": "99b80a01-fd16-4c8a-9716-db37407bdc67",
        "started_at": "2023-06-12 17:30:21",
        "ended_at": "2023-06-12 17:30:21",
        "flight_date": "2023-06-12",
        "flight_status": "Completed",
        "flight_number": "A121312",
        "distance_mi": "9164",
        "distance_km": "14745",
        "departure": {
          "id": "36616115-61ba-4890-a6ce-ddb4e4e68ec4",
          "iata_code": "ATD",
          "icao_code": "AGAT",
          "airport_name": "Atoifi"
        },
        "arrival": {
          "id": "300a8ec20-ad3b-4377-a003-0baa23deae3e",
          "iata_code": "ERM",
          "icao_code": "SSER",
          "airport_name": "Comandante Kraemer"
        },
        "airline": {
          "id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
          "iata_code": "7P",
          "icao_code": "PST",
          "airline_name": "Air Panama dba Parsa, S.A."
        },
        "emission": {
          "scope": "3",
          "carbon_equivalent": "6573.6700",
          "carbon_dioxide": "2641.0894",
          "methane": "0.1460",
          "nitrous_oxide": "13.1397"
        }
      }
    ]
  },
  "meta": {}
}

Successful operation

Delete air-travel

remove air-travel

delete

/air-travel/{id}

Path parameters

idstringrequired

ID of The AirTravel

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/{id}'

200

400

403

404

500

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

Successful operation