Air travel

Retrieve all AirTravelSegment

Retrieve all AirTravelSegment that belong to a company

GEThttp://app.greenplaces.com/api/air-travel

Query parameters

Response

Successful operation

Headers

Body

statusstring

messagestring

dataarray of AirTravelResource

metaobject

Request

const response = await fetch('http://app.greenplaces.com/api/air-travel', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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",
          "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"
          },
          "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",
          "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"
    }
  }
}

Store an AirTravel

Store an AirTravel for a particular compny.

POSThttp://app.greenplaces.com/api/air-travel

Body

traveler_nametraveler_name

name of the air-travel

traveler_emailtraveler_email

traveler_email of the air-travel

spend_amountspend_amount

spend_amount of the air-travel

currencycurrency

currency of the air-travel, by default is USD

segments*segments

segments of the air-travel

Response

Successful operation

Headers

Body

statusstring

messagestring

data AirTravelResource

Airtravel Resource

metaobject

Request

const response = await fetch('http://app.greenplaces.com/api/air-travel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "segments": [
        {
          "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
          "flight_date": "2023-03-17",
          "flight_number": "A1212",
          "departure_id": "AGAT",
          "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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",
        "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"
        },
        "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",
        "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"
        }
      }
    ]
  }
}

Get air-travel

obtain information about a air-travel

GEThttp://app.greenplaces.com/api/air-travel/{id}

Path parameters

id*string

ID of The AirTravel

Response

Successful operation

Headers

Body

statusstring

messagestring

data AirTravelResource

Airtravel Resource

metaobject

Request

const response = await fetch('http://app.greenplaces.com/api/air-travel/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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",
        "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"
        },
        "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",
        "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"
        }
      }
    ]
  }
}

Update AirTravel

Update an AirTravel for a company

PUThttp://app.greenplaces.com/api/air-travel/{id}

Path parameters

id*string

ID of The AirTravel

Body

traveler_nametraveler_name

name of the air-travel

traveler_emailtraveler_email

traveler_email of the air-travel

spend_amountspend_amount

spend_amount of the air-travel

currencycurrency

currency of the air-travel, by default is USD

segments*segments

segments of the air-travel

Response

Successful operation

Headers

Body

statusstring

messagestring

data AirTravelResource

Airtravel Resource

metaobject

Request

const response = await fetch('http://app.greenplaces.com/api/air-travel/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "segments": [
        {
          "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc",
          "flight_date": "2023-03-17",
          "flight_number": "A1212",
          "departure_id": "AGAT",
          "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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",
        "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"
        },
        "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",
        "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"
        }
      }
    ]
  }
}

Delete air-travel

remove air-travel

DELETEhttp://app.greenplaces.com/api/air-travel/{id}

Path parameters

id*string

ID of The AirTravel

Response

Successful operation

Headers

Body

statusstring

messagestring

datastring

metaobject

Request

const response = await fetch('http://app.greenplaces.com/api/air-travel/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "Ok",
  "message": "Success",
  "data": "text"
}

PreviousAPI Reference NextBulk

Last updated 9 months ago

{ "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", "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" }, "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", "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" } } }

const response = await fetch('http://app.greenplaces.com/api/air-travel', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "segments": [ { "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc", "flight_date": "2023-03-17", "flight_number": "A1212", "departure_id": "AGAT", "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee" } ] }), }); const data = await response.json();

{ "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", "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" }, "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", "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" } } ] } }

const response = await fetch('http://app.greenplaces.com/api/air-travel/{id}', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "segments": [ { "airline_id": "000f13cd-d397-44cb-948b-edace9f8b4dc", "flight_date": "2023-03-17", "flight_number": "A1212", "departure_id": "AGAT", "arrival_id": "730fcf91-1d3c-44e7-b4ef-7c9dbb7d8aee" } ] }), }); const data = await response.json();