Table of Contents


1 Quick Start Guide

1.1 Set Reservation Workflow

  1. Home page
  2. Parking Lots Listings Page
  3. Parking Lot Details Page
  4. Reservation Billing Page
  5. Reservation Confirmation Page

1.1.1 Home Page

Display a list of Airports for customer to choose from. Default selected airport to the nearest one based on customer’s ip address.

Methods used:

1.1.2 Parking Lots Listings Page

Display a list of parking lots based on selected airport from Home Page.

Methods used:

1.1.3 Parking Lot Details Page

Display detailed information about a particular lot

Methods used:

1.1.4 Reservation Billing Page

Methods used:

1.1.5 Reservation Confirmation page

Display customer's reservation details

Methods used:


2 Methods

2.1 airport Methods

The airport resource contains all fields and actions related to a physical airport. Airports have information in the following categories:

  • address
  • geolocation
  • URL to official site
  • IATA code and full name

Our database includes airports in the USA, Canada, United Kingdom, Australia, and New Zealand.

Airports and parking lots are related through the airport_id key.

Airports may be presented to the user in any order. The get_nearest method is provided to find airports close to a requested IP address. This allows ordering airports by distance.

2.1.1 airport.list

API Explorer: airport.list

Lists all airports

Endpoint Information:

HTTP MethodGET
Default Response Fieldsairport_id, airport_code, airport_name

Parameters:

tokenrequiredYour API Token
countoptionalNumber of records to return
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
airport_codeThree letter code identifying airportSFO
airport_nameThe airport that the parking lot is affiliated withLos Angeles International Airport
airport_latitudeAirport's latitude33.944141
airport_longitudeAirport's longitude-118.397450
airport_cityCity name of airportPhoenix
airport_state_provinceState abbreviation of airport OR province nameCA; Scotland
airport_country_idUnique key identifying country8
airport_websiteURL of airport's official websitewww.lawa.org/lax/welcomeLAX.cfm
compact_nameA shortened name for the airport: city + IATA codeSouthampton (SOU)

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/airport/list?token=YOUR_TOKEN&count=5"

Example Response:

{
  "status":"ok",
  "items":{
    "861":{
      "airport_id":"861",
      "airport_name":"Aberdeen Airport ",
      "airport_code":"ABZ"
    },
    "868":{
      "airport_id":"868",
      "airport_name":"Adelaide International Airport",
      "airport_code":"ADL"
    },
    "103":{
      "airport_id":"103",
      "airport_name":"Albany International Airport",
      "airport_code":"ALB"
    },
    "84":{
      "airport_id":"84",
      "airport_name":"Albuquerque International Sunport",
      "airport_code":"ABQ"
    },
    "90":{
      "airport_id":"90",
      "airport_name":"Anchorage International Airport",
      "airport_code":"ANC"
    }
  }
}

2.1.2 airport.get

API Explorer: airport.get

Get info on a specific airport

Endpoint Information:

HTTP MethodGET
Default Response Fieldsairport_id, airport_code, airport_longitude, airport_latitude

Parameters:

tokenrequiredYour API Token
airport_idrequiredUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
airport_codeThree letter code identifying airportSFO
airport_nameThe airport that the parking lot is affiliated withLos Angeles International Airport
airport_latitudeAirport's latitude33.944141
airport_longitudeAirport's longitude-118.397450
airport_cityCity name of airportPhoenix
airport_state_provinceState abbreviation of airport OR province nameCA; Scotland
airport_country_idUnique key identifying country8
airport_websiteURL of airport's official websitewww.lawa.org/lax/welcomeLAX.cfm
compact_nameA shortened name for the airport: city + IATA codeSouthampton (SOU)

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/airport/get?token=YOUR_TOKEN&airport_id=55"

Example Response:

{
  "status":"ok",
  "items":{
    "55":{
      "airport_id":"55",
      "airport_code":"BWI",
      "airport_longitude":"-76.673858",
      "airport_latitude":"39.183399"
    }
  }
}

2.1.3 airport.get_nearest

API Explorer: airport.get_nearest

Get airports nearest the specified IP address

Endpoint Information:

HTTP MethodGET
Default Response Fieldsairport_id, airport_code, airport_name

Parameters:

tokenrequiredYour API Token
iprequiredIP address to use for locating airports
countoptionalNumber of records to return
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
airport_codeThree letter code identifying airportSFO
airport_nameThe airport that the parking lot is affiliated withLos Angeles International Airport
airport_latitudeAirport's latitude33.944141
airport_longitudeAirport's longitude-118.397450
airport_cityCity name of airportPhoenix
airport_state_provinceState abbreviation of airport OR province nameCA; Scotland
airport_country_idUnique key identifying country8
airport_websiteURL of airport's official websitewww.lawa.org/lax/welcomeLAX.cfm
compact_nameA shortened name for the airport: city + IATA codeSouthampton (SOU)

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/airport/get_nearest?token=YOUR_TOKEN&ip=74.125.224.200&count=5"

Example Response:

{
  "status":"ok",
  "items":{
    "66":{
      "airport_id":"66",
      "airport_name":"San Jose Norman Y. Mineta",
      "airport_code":"SJC"
    },
    "62":{
      "airport_id":"62",
      "airport_name":"Oakland International Airport",
      "airport_code":"OAK"
    },
    "44":{
      "airport_id":"44",
      "airport_name":"San Francisco International Airport",
      "airport_code":"SFO"
    },
    "68":{
      "airport_id":"68",
      "airport_name":"Sacramento International Airport",
      "airport_code":"SMF"
    },
    "89":{
      "airport_id":"89",
      "airport_name":"Reno-Tahoe International Airport",
      "airport_code":"RNO"
    }
  }
}

2.2 parking Methods

The parking resource contains all fields and actions related to a physical parking lot.
Parking lots are associated with an airport through the airport_id key. Parking lots have information in the following categories:

  • address
  • geolocation
  • an optional owner-provided description and FAQ
  • optional photos of the parking lot and shuttle
  • user reviews and shuttle wait times

Our database contains parking lots that in the USA, Canada, United Kingdom, Australia, and New Zealand.

Parking lots may be presented to the user in typical sort orders (distance, rating, or parking cost). The AirportParking.com API also provides a sort value, top_results_sort_value that blends distance, price, and review. It is recommended that this sort value be used initially when displaying a list of parking lots.

Requesting Calculations

Two parking methods parking.list and parking.get can be used to reduce the number of requests needed to generate parking lot lists and detail pages. These methods support a grouped field, calculate, which automatically calls reservation.calculate for each parking lot that is found. To use this optional technique specify calculate in the fields parameter and provide the related parameters: start_date, end_date, start_time, end_time, parking_type_id. When using the calculate grouped field, the optional parameter parking_type_id can be omitted. If this is the case, values will be calculated for each parking types that each parking lot supports.

For more information on the grouped field calculate, please see the description for reservation.calculate below.

2.2.1 parking.list

API Explorer: parking.list

Lists parking lots near the chosen airport

Endpoint Information:

HTTP MethodGET
Default Response Fieldsparking_id, parking_name, parking_city, direction, distance, parking_latitude, parking_longitude, parking_rate, parking_rate_count, top_results_sort_value, partnership, parking_types, shuttle_wait_time, shuttle_wait_time_count

Parameters:

tokenrequiredYour API Token
airport_idrequiredUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code
start_dateoptionalString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.
end_dateoptionalString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.
start_timeoptionalString in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time)
end_timeoptionalString in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time)
parking_type_idoptionalA single parking type ID offered by the parking lot
countoptionalNumber of records to return
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
calculate (group)Returns a calculation of the cost for each of the types of parking that the parking lot offers. When specifying this requestedField you must also include start_date, start_time, end_date, and end_time argumentsThis group includes booking_fee, booking_discount, tax, fee, fee_daily, deposit, subtotal, tax_due, fee_daily_total, usd_deposit, total, amount_due, timerate
reviews (group)Returns reviews section for each parking lotThis group includes review_comment, review_subject, review_vote, review_title, review_parking_id, review_datetime
parking_types (group)Returns array of parking lot's parking typesThis group includes parking_type_id, parking_type_name
payment_types (group)A list of payment methods that are accepted by this parking lot. These types are only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.This group includes payment_type_id, payment_type_name
parking_idThe unique key identfying this parking lot155
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
parking_nameThe name of the parking facility this reservation is booked atLAX Park
parking_addressThe street address of the parking facility this reservation is booked at8911 Bellanca Ave
parking_cityThe city of the parking facility this reservation is booked atLos Angeles
parking_stateThe state of the parking facility this reservation is booked atCA
parking_zipReturns the parking lot's zip code90445
parking_phoneThe phone number of the parking facility this reservation is booked at(310) 670-9945
country_idCountry code of the parking facility4
directionThe direction the parking lot lies with respect to the airportnorth
distanceThe parking lot's distance from airport2.0
parking_latitudeReturns the parking lot's latitude33.948380
parking_longitudeReturns the parking lot's longitude-118.396150
shuttle_infoInformation about shuttle provided by the parking facility the reservation is booked atContinuous shuttle to and from LAX free of charge.
descriptionParking lot description, may include HTML<p> <b>Please Note:\u00a0 Credit Card payment is the only payment accepted for airport parking...
reviews (group)Returns reviews section for each parking lotThis group includes review_comment, review_subject, review_vote, review_title, review_parking_id, review_datetime
partnershipThe parking lot's partnership flag. A value of 100 means a reservation can be made online; other values indicate parking lots that do not accept reservations online.100
shuttle_wait_timeThe average shuttle wait time in minutes19
shuttle_wait_time_countThe number of reports of shuttle wait time used to calculate shuttle_wait_time4
payment_type_namesA string indicating payment type IDS that are accepted by this parking lot. It is comma separated. This type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.Master Card,American Express
payment_type_idsA string indicating payment type IDS that are accepted by this parking lot. It is comma separatedThis type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.3,4
parking_rate_countReturns the parking lot's number of customers that rated. If not specififed, no reviews are available for this lot.6
parking_rateReturns the parking lot's average customer rating. If not specified, no reviews are available for this lot.2.0
photo_urlURL of photo of this parking lothttp://www.aboutairportparking.com/files/parking_pics/Picture 064.jpg
top_results_sort_valueReturns a score that is used for sorting parking lots. The score is a weighted sum of distance, price, and review ratings31.203157298226
parking_type_nameA single parking type name offerd by the parking lotCovered Valet
parking_type_idA single parking type ID offered by the parking lot2
parking_type_idsA string indicating parking type IDs offered by the parking lot. It is comma separated if more than one parking type ID exists1,3
parking_type_namesA string indicating parking type names offered by the parking lot. It is comma separated if more than one parking type name existsOutdoor Self,Covered Valet

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/parking/list?token=YOUR_TOKEN&airport_id=33&count=3"

Example Response:

{
  "status":"ok",
  "items":{
    "138":{
      "parking_id":"138",
      "parking_name":"LAX Lot C",
      "parking_city":"Los Angeles",
      "direction":"north",
      "distance":"1.7",
      "parking_longitude":"-118.396150",
      "parking_latitude":"33.948380",
      "parking_rate":"3.50",
      "parking_rate_count":"4",
      "partnership":"0",
      "parking_types":[
        {
          "parking_type_id":"1",
          "parking_type_name":"Outdoor Self Park"
        }
      ],
      "top_results_sort_value":63.0174
    },
    "139":{
      "parking_id":"139",
      "parking_name":"LAX Lot B",
      "parking_city":"Los Angeles",
      "direction":"north",
      "distance":"2.6",
      "parking_longitude":"-118.369912",
      "parking_latitude":"33.934308",
      "parking_rate":"2.11",
      "parking_rate_count":"22",
      "partnership":"0",
      "parking_types":[
        {
          "parking_type_id":"1",
          "parking_type_name":"Outdoor Self Park"
        }
      ],
      "top_results_sort_value":5062.6082
    },
    "140":{
      "parking_id":"140",
      "parking_name":"Johnny Park",
      "parking_city":"Los Angeles ",
      "direction":"north",
      "distance":"2.0",
      "parking_longitude":"-118.372408",
      "parking_latitude":"33.934313",
      "parking_rate":"4.18",
      "parking_rate_count":"142",
      "partnership":"100",
      "shuttle_wait_time":"19",
      "shuttle_wait_time_count":"4",
      "parking_types":[
        {
          "parking_type_id":"1",
          "parking_type_name":"Outdoor Self Park"
        },
        {
          "parking_type_id":"3",
          "parking_type_name":"Outdoor Valet"
        },
        {
          "parking_type_id":"4",
          "parking_type_name":"Covered Valet"
        }
      ],
      "top_results_sort_value":1163.291
    }
  }
}

2.2.2 parking.get

API Explorer: parking.get

Gets details on a specific parking lot

Endpoint Information:

HTTP MethodGET
Default Response Fieldsparking_id, parking_name, parking_address, parking_city, parking_state, parking_zip, parking_phone, direction, distance, parking_latitude, parking_longitude, shuttle_info, description, faq, photo_url, reviews, parking_rate, parking_rate_count, shuttle_wait_time, parking_types, payment_types

Parameters:

tokenrequiredYour API Token
parking_idrequiredThe unique key identfying this parking lot
start_dateoptionalString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.
end_dateoptionalString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.
start_timeoptionalString in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time)
end_timeoptionalString in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time)
countoptionalNumber of records to return
parking_type_idoptionalA single parking type ID offered by the parking lot
photo_countoptionalMaximum number of photos to return for parking lot
review_countoptionalNumber of reviews to return, defaults to 3
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
calculate (group)Returns a calculation of the cost for each of the types of parking that the parking lot offers. When specifying this requestedField you must also include start_date, start_time, end_date, and end_time argumentsThis group includes booking_fee, booking_discount, tax, fee, fee_daily, deposit, subtotal, tax_due, fee_daily_total, usd_deposit, total, amount_due, timerate
parking_types (group)Returns array of parking lot's parking typesThis group includes parking_type_id, parking_type_name
payment_types (group)A list of payment methods that are accepted by this parking lot. These types are only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.This group includes payment_type_id, payment_type_name
parking_idThe unique key identfying this parking lot155
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
parking_nameThe name of the parking facility this reservation is booked atLAX Park
parking_addressThe street address of the parking facility this reservation is booked at8911 Bellanca Ave
parking_cityThe city of the parking facility this reservation is booked atLos Angeles
parking_stateThe state of the parking facility this reservation is booked atCA
parking_zipReturns the parking lot's zip code90445
parking_phoneThe phone number of the parking facility this reservation is booked at(310) 670-9945
country_idCountry code of the parking facility4
directionThe direction the parking lot lies with respect to the airportnorth
distanceThe parking lot's distance from airport2.0
parking_latitudeReturns the parking lot's latitude33.948380
parking_longitudeReturns the parking lot's longitude-118.396150
shuttle_infoInformation about shuttle provided by the parking facility the reservation is booked atContinuous shuttle to and from LAX free of charge.
descriptionParking lot description, may include HTML<p> <b>Please Note:\u00a0 Credit Card payment is the only payment accepted for airport parking...
reviews (group)Returns reviews section for each parking lotThis group includes review_comment, review_subject, review_vote, review_title, review_parking_id, review_datetime
partnershipThe parking lot's partnership flag. A value of 100 means a reservation can be made online; other values indicate parking lots that do not accept reservations online.100
shuttle_wait_timeThe average shuttle wait time in minutes19
shuttle_wait_time_countThe number of reports of shuttle wait time used to calculate shuttle_wait_time4
payment_type_namesA string indicating payment type IDS that are accepted by this parking lot. It is comma separated. This type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.Master Card,American Express
payment_type_idsA string indicating payment type IDS that are accepted by this parking lot. It is comma separatedThis type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types.3,4
parking_rate_countReturns the parking lot's number of customers that rated. If not specififed, no reviews are available for this lot.6
parking_rateReturns the parking lot's average customer rating. If not specified, no reviews are available for this lot.2.0
photo_urlURL of photo of this parking lothttp://www.aboutairportparking.com/files/parking_pics/Picture 064.jpg
top_results_sort_valueReturns a score that is used for sorting parking lots. The score is a weighted sum of distance, price, and review ratings31.203157298226
parking_type_idA single parking type ID offered by the parking lot2
parking_type_nameA single parking type name offerd by the parking lotCovered Valet
parking_type_idsA string indicating parking type IDs offered by the parking lot. It is comma separated if more than one parking type ID exists1,3
parking_type_namesA string indicating parking type names offered by the parking lot. It is comma separated if more than one parking type name existsOutdoor Self,Covered Valet

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/parking/get?token=YOUR_TOKEN&parking_id=1780"

Example Response:

{
  "status":"ok",
  "items":{
    "1780":{
      "parking_id":"1780",
      "parking_name":"Hilton Los Angeles Airport Valet",
      "parking_address":"5711 West Century Boulevard",
      "parking_city":"Los Angeles ",
      "parking_state":"CA",
      "parking_zip":"90045",
      "parking_phone":"(310) 410-6036",
      "direction":"north",
      "distance":"1.5",
      "parking_longitude":"-118.380830",
      "parking_latitude":"33.945413",
      "parking_rate":"4.43",
      "parking_rate_count":"519",
      "shuttle_info":"Shuttle runs every 15 minutes \u2013 24 Hours \/ 7 Days a Week.",
      "description":"<p>\r\n<b>Please Note:\u00a0 Credit Card payment is the only payment accepted for airport parking.\u00a0\u00a0 <\/b>\r\n<\/p>\r\n<p>\r\nHilton Los Angeles Airport offers LAX easy and convenient airport parking. The Hilton Los Angeles Airport is located just a quarter mile from Los Angeles International Airport (LAX), which is only a 5 minute shuttle ride. Please arrive at the hotel 25-30 minutes before you would like to be at the terminal. \r\n<\/p>\r\n<p>\r\nWhen you return to LAX from your trip, you are welcome to call 310.410.6040 to have your vehicle ready when you arrive at the hotel. Please wait under the red sign that reads &quot;Hotel Shuttle Pick Up&quot; at the airport for the Hilton LAX shuttle that picks up every 15-20 minutes, 24 hours a day. \r\n<\/p>\r\n<p>\r\nWhen you are on the shuttle back to the hotel, you are welcome to send us a text message with your valet ticket number to 310-699-3454 to have your vehicle ready when you arrive at the hotel. \r\n<\/p>\r\n<p>\r\n<meta content=\"Word.Document\" name=\"ProgId\" \/>\r\n<meta content=\"Microsoft Word 12\" name=\"Generator\" \/>\r\n<meta content=\"Microsoft Word 12\" name=\"Originator\" \/>\r\n<link rel=\"File-List\" href=\"file:\/\/\/C:%5CDOCUME%7E1%5Csernickr%5CLOCALS%7E1%5CTemp%5Cmsohtmlclip1%5C01%5Cclip_filelist.xml\" \/>\r\n<link rel=\"themeData\" href=\"file:\/\/\/C:%5CDOCUME%7E1%5Csernickr%5CLOCALS%7E1%5CTemp%5Cmsohtmlclip1%5C01%5Cclip_themedata.thmx\" \/>\r\n<link rel=\"colorSchemeMapping\" href=\"file:\/\/\/C:%5CDOCUME%7E1%5Csernickr%5CLOCALS%7E1%5CTemp%5Cmsohtmlclip1%5C01%5Cclip_colorschememapping.xml\" \/>\r\n<style>\r\n<!--\r\n\/* Font Definitions *\/\r\[email protected]\r\n{font-family:\"Cambria Math\";\r\npanose-1:2 4 5 3 5 4 6 3 2 4;\r\nmso-font-charset:0;\r\nmso-generic-font-family:roman;\r\nmso-font-pitch:variable;\r\nmso-font-signature:-1610611985 1107304683 0 0 159 0;}\r\[email protected]\r\n{font-family:Calibri;\r\npanose-1:2 15 5 2 2 2 4 3 2 4;\r\nmso-font-charset:0;\r\nmso-generic-font-family:swiss;\r\nmso-font-pitch:variable;\r\nmso-font-signature:-1610611985 1073750139 0 0 159 0;}\r\n\/* Style Definitions *\/\r\np.MsoNormal, li.MsoNormal, div.MsoNormal\r\n{mso-style-unhide:no;\r\nmso-style-qformat:yes;\r\nmso-style-parent:\"\";\r\nmargin:0in;\r\nmargin-bottom:.0001pt;\r\nmso-pagination:widow-orphan;\r\nfont-size:10.5pt;\r\nmso-bidi-font-size:11.0pt;\r\nfont-family:\"Arial\",\"sans-serif\";\r\nmso-fareast-font-family:Calibri;\r\nmso-fareast-theme-font:minor-latin;\r\nmso-bidi-font-family:\"Times New Roman\";\r\nmso-bidi-theme-font:minor-bidi;\r\ncolor:#150E9A;}\r\nspan.EmailStyle15\r\n{mso-style-type:personal;\r\nmso-style-noshow:yes;\r\nmso-style-unhide:no;\r\nmso-ansi-font-size:10.5pt;\r\nmso-bidi-font-size:11.0pt;\r\nfont-family:\"Arial\",\"sans-serif\";\r\nmso-ascii-font-family:Arial;\r\nmso-hansi-font-family:Arial;\r\nmso-bidi-font-family:\"Times New Roman\";\r\nmso-bidi-theme-font:minor-bidi;\r\ncolor:#150E9A;\r\nmso-text-animation:none;\r\nfont-weight:normal;\r\nfont-style:normal;\r\ntext-decoration:none;\r\ntext-underline:none;\r\ntext-decoration:none;\r\ntext-line-through:none;}\r\n.MsoChpDefault\r\n{mso-style-type:export-only;\r\nmso-default-props:yes;\r\nmso-ascii-font-family:Calibri;\r\nmso-ascii-theme-font:minor-latin;\r\nmso-fareast-font-family:Calibri;\r\nmso-fareast-theme-font:minor-latin;\r\nmso-hansi-font-family:Calibri;\r\nmso-hansi-theme-font:minor-latin;\r\nmso-bidi-font-family:\"Times New Roman\";\r\nmso-bidi-theme-font:minor-bidi;}\r\[email protected] Section1\r\n{size:8.5in 11.0in;\r\nmargin:1.0in 1.0in 1.0in 1.0in;\r\nmso-header-margin:.5in;\r\nmso-footer-margin:.5in;\r\nmso-paper-source:0;}\r\ndiv.Section1\r\n{page:Section1;}\r\n--><\/style><span style=\"font-family: 'Arial','sans-serif'; color: #150e9a; font-size: 10.5pt\"><\/span>\r\n<\/p>\r\n<p>\r\nParking at the Hilton Los Angeles Airport is covered &amp; secured 24 hours a day.\u00a0 \r\n<\/p>\r\n<p>\r\n<u><b>Our parking garage can only accomodate vehicles 6'2&quot; and below.\u00a0 Any vehicle above 6'2&quot; will not fit. <\/b><\/u>\r\n<\/p>\r\n<p>\r\nNOTE: This offer is valid for valet parking only. Please do not use the self-parking option. \r\n<\/p>\r\n<p>\r\nParking Address: 5711 W Century Blvd. Los Angeles, CA 90045 \r\n<\/p>\r\n<p>\r\n<b><br \/>\r\n<\/b>\r\n<\/p>\r\n",
      "faq":"<p>\r\n<b>PLEASE NOTE: <\/b>There are two parking options at the LAX Hilton: a valet service and a 100% full automated self-park option. This is the valet option. When you drop your car off, please go to the main hotel entrance for valet parking. Please do not go to the self-park entrance \r\n<\/p>\r\n<p>\r\nCredit Card payment is the only payment accepted for airport parking at the Hilton LAX. No cash accepted.\u00a0 \r\n<\/p>\r\n\r\n<p style=\"color:red;font-size:16px;font-weight:bold;\">\r\nPlease print and bring your confirmation email as proof of your reservation.  \r\nYou must have it with you to receive credit for your prepayment\r\n<\/p>\r\n<div style=\"color:darkblue; font-size:19px;font-weight:bold;\">\r\n<div style=\"float: right; width: 280px; text-align: right\">\r\n<img src=\"\/files\/hilton-lax-parking-1.jpg\" style=\"padding: 5px\" alt=\"Hilton Hotel Los Angeles Parking\">\r\n<img src=\"\/files\/hilton-lax-parking-3.jpg\" style=\"padding: 10px;\" alt=\"Convenient Hilton Shuttle for LAX Airport Parking\">\r\n<img src=\"\/files\/hilton-lax-parking-4.jpg\" style=\"padding: 10px;\" alt=\"Speedy Hilton Valet Service\">\r\n<\/div>\r\nWhen arriving to the hotel, advise the valet staff that you are airport parking.  Upon return, the cashier will request for your printed receipt and you will pay your balance due\r\n<br><br>\r\nOur airport shuttles run \r\n24 hours a day departing every \r\n15-20 minutes from the hotel\r\nPlease be at the hotel 30 min. before you would like to be at the airport\r\n<br><br>\r\nReduce your wait and \r\ntext for your car!\r\nText your valet ticket number to \r\n310-699-3454 \r\nonce you are on the airport shuttle\r\n<\/div>\r\n\r\n<div style=\"clear: both\"><\/div>\r\n<p style=\"color:black;font-weight:bold;font-size:12px;\">\r\nPlease Note:\r\nReservations can be canceled up to 48 hours prior to your arrival date with a full refund.\r\nValet parking can only accommodate vehicles 6\u2019 2\u201d and below.  \r\nAny vehicle over 6\u20192\u201d will not fit into our parking garage. \r\nIf you return prior to your reservation departure date, an early departure fee of two nights will be charged.\r\n<\/p>\r\n",
      "payment_types":[
        {
          "payment_type_id":"1",
          "payment_type_name":"Visa"
        },
        {
          "payment_type_id":"2",
          "payment_type_name":"Master Card"
        },
        {
          "payment_type_id":"3",
          "payment_type_name":"American Express"
        },
        {
          "payment_type_id":"5",
          "payment_type_name":"Discover"
        }
      ],
      "shuttle_wait_time":"8",
      "parking_types":[
        {
          "parking_type_id":"4",
          "parking_type_name":"Covered Valet"
        }
      ],
      "photos":[
        {
          "photo_url":"http:\/\/www.aboutairportparking.com\/files\/imagecache\/parking_lot_resized\/parking_pics\/hilton-self-park-new4.jpg"
        }
      ],
      "reviews":[
        {
          "review_timestamp":"1315598507",
          "review_subject":"N\/A entry",
          "review_comment":"Does this get included?\r\n",
          "review_type":"registered",
          "review_vote":"5",
          "review_parking_id":"1780",
          "review_datetime":"2011-09-09 13:01"
        },
        {
          "review_timestamp":"1315532872",
          "review_subject":"not applicable.",
          "review_comment":"there was no shuttkl1! ever plox bring shuttle!\r\n",
          "review_type":"registered",
          "review_vote":"5",
          "review_parking_id":"1780",
          "review_datetime":"2011-09-08 18:47"
        },
        {
          "review_timestamp":"1315532829",
          "review_subject":"5-10 mins",
          "review_comment":"5-10 mins\r\n",
          "review_type":"registered",
          "review_vote":"5",
          "review_parking_id":"1780",
          "review_datetime":"2011-09-08 18:47"
        }
      ]
    }
  }
}

2.2.3 parking.reviews

API Explorer: parking.reviews

Gets the reviews on a specific parking lot

Endpoint Information:

HTTP MethodGET
Default Response Fieldsreview_timestamp, review_datetime, review_subject, review_comment, review_type, review_vote

Parameters:

tokenrequiredYour API Token
parking_idrequiredThe unique key identfying this parking lot
review_countoptionalNumber of reviews to return, defaults to 3
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
review_timestampThe time of submission of this review1217628363
review_subjectSubject of parking lot reviewThis is a great lot!
review_commentBody of parking lot reviewGreat lot, prompt service!
review_typeThe type of review: anonymous, registered, verifiedverified
review_voteUser's vote for this parking lot (1-5 with 5 being best)4
review_parking_idParking lot id for which the review was written142

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/parking/reviews?token=YOUR_TOKEN&parking_id=1780"

Example Response:

{
  "status":"ok",
  "items":[
    {
      "review_timestamp":"1315598507",
      "review_subject":"N\/A entry",
      "review_comment":"Does this get included?\r\n",
      "review_type":"registered",
      "review_vote":"5",
      "review_datetime":"2011-09-09 13:01"
    },
    {
      "review_timestamp":"1315532872",
      "review_subject":"not applicable.",
      "review_comment":"there was no shuttkl1! ever plox bring shuttle!\r\n",
      "review_type":"registered",
      "review_vote":"5",
      "review_datetime":"2011-09-08 18:47"
    },
    {
      "review_timestamp":"1315532829",
      "review_subject":"5-10 mins",
      "review_comment":"5-10 mins\r\n",
      "review_type":"registered",
      "review_vote":"5",
      "review_datetime":"2011-09-08 18:47"
    }
  ]
}

2.3 reservation Methods

The reservation resource contains all fields and actions related to a parking reservation.

Reservations are associated with an a parking lot through the parking_id key. Reservations contain information in the following categories:

  • associated parking lot information (id, name, address)
  • reservation holder information (id, name, email)
  • start and end date and time
  • type of parking (valet, indoor, etc)
  • itemized cost of parking reservation and amount deposited
  • a barcode for parking lot use
  • associated airport information (id)
  • a security hash used for changing or cancelling the reservation

Reservations may be retrieved using a combination of email address and reservation ID.
If the reservation ID is unknown, a list of reservations can be generated as long as a user ID was present when creating the reservation. For more information on user IDs please see the section on the User resource.

2.3.1 reservation.get

API Explorer: reservation.get

Gets details of a specific reservations

This method returns details of a specific reservation. Note that only reservations created or assigned to your access token will be accessible.

This method both a reservation_id and an email address to be specified and match the information on the reservation. This allows n user to retrieve a reservation using simple identifiers but prevents him from retrieving other reservations just by manipulating the reservation_id.

Endpoint Information:

HTTP MethodGET
Default Response Fieldsreservation_id, start_date, end_date, cost, deposit, state, firstname, lastname, email, created, parking_name, parking_address, parking_city, parking_state, parking_phone, shuttle_info, airport_name, barcode, fee, fee_daily, fee_daily_total, tax, amount_due, subtotal, booking_fee, booking_discount, parking_type, verify_hash, parking_id, airport_id, billing_user_id, billing_email, billing_firstname, billing_lastname, billing_street, billing_suite, billing_city, billing_state, billing_zip, billing_country

Parameters:

tokenrequiredYour API Token
reservation_idrequiredUnique key identifying reservation
emailrequiredThe email address of the user
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
reservation_idUnique key identifying reservation272329
start_dateString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.2012-03-06
end_dateString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.2012-03-06
costCost of reservation in dollars60.00
depositAmount of deposit taken for reservation in dollars5.00
stateState of this reservation, an enumerated type, see section 4.2 for definitions1
firstnameThe first name of the person holding this reservationJane
lastnameThe last name of the person holding this reservationSmith
emailThe email address of the user[email protected]
createdString in YYYY-MM-DD HH:MM format indicating the calendar date and time of the creation of the reservation. The timezone of the created string is interpreted to be the timezone of the parking lot (local time)2012-03-06 18:00:00
parking_nameThe name of the parking facility this reservation is booked atLAX Park
parking_addressThe street address of the parking facility this reservation is booked at8911 Bellanca Ave
parking_cityThe city of the parking facility this reservation is booked atLos Angeles
parking_stateThe state of the parking facility this reservation is booked atCA
parking_phoneThe phone number of the parking facility this reservation is booked at(310) 670-9945
shuttle_infoInformation about shuttle provided by the parking facility the reservation is booked atContinuous shuttle to and from LAX free of charge.
airport_nameThe airport that the parking lot is affiliated withLos Angeles International Airport
barcodeA link to a barcode that can be displayed on a reservation confirmation screen. http://airportparking.com/barcode.php?reservation_id=272329
feeone-time fee, charged per reservation (in addition to lot rate)1
fee_dailyfee amount charged each day of the reservation (in addition to lot rate)2
fee_daily_totalsum of daily fees -- does not include fee above18
taxpercent tax levied against subtotal10
amount_dueThe amount due by the holder of the reservation upon its use, in dollars55.00
subtotalSubtotal of parking cost, prior to calculation of taxes, in dollars30.00
booking_feeConvenience cost of using reservation system, in dollars5.00
booking_discountDiscount on booking for using reservation system, in dollars5.00
parking_typeDescription of type of parkingOutdoor Valet
verify_hashThis is a verification code specific to the reservation. It is submitted as an argument to reservation.cancel to ensure that the correct reservation is being cancelled5fbccfdcdac74c383b5981c96c00b1ec
parking_idThe unique key identfying this parking lot155
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT
billing_emailThe email address of the person paying for this reservation[email protected]
billing_firstnameThe first name of the person paying for this reservationBen
billing_lastnameThe last name of the person requesting this reservationFranklin
billing_streetThe billing street address associated with this credit card327 Main Street
billing_suiteThe second line of the billing address associated with this credit card. Suite 132
billing_cityThe city associated with this credit cardLos Angeles
billing_stateThe state or province associated with this credit cardCA
billing_zipThe zipcode associated with this credit card90071
billing_countryThe country associated with this credit cardUSA

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/reservation/get?token=YOUR_TOKEN&reservation_id=273799&email=aapapitest%40oversee.net"

Example Response:

{
  "items":{
    "273799":{
      "reservation_id":"273799",
      "start_date":"1969-12-31 16:33:32",
      "end_date":"2038-01-18 19:14:07",
      "cost":"60.00",
      "deposit":"6.00",
      "state":"1",
      "firstname":"TEST: Reservation Already Started",
      "lastname":"AAP API TEST CASE",
      "email":"[email protected]",
      "created":"2012-01-30 19:11:35",
      "parking_name":"AAP API TEST CASE Parking Lot",
      "parking_address":"515 S. Flower Street",
      "parking_city":"Los Angeles",
      "parking_state":"CA",
      "parking_phone":"(213) 408-0080",
      "shuttle_info":"This lot does not have a shuttle.",
      "airport_name":"Los Angeles International Airport",
      "airport_id":"33",
      "verify_hash":"c66d8e5d66772d4d0ef093137f8222aa",
      "parking_type":"Outdoor Self Park"
    }
  },
  "status":"ok"
}

2.3.2 reservation.set

API Explorer: reservation.set

Creates a new parking reservation

Endpoint Information:

HTTP MethodPOST
Default Response Fieldsreservation_id, cc_token, verify_hash

Parameters:

tokenrequiredYour API Token
parking_idrequiredThe unique key identfying this parking lot
parking_type_idrequiredA single parking type ID offered by the parking lot
emailrequiredThe email address of the user
firstnamerequiredThe first name of the person holding this reservation
lastnamerequiredThe last name of the person holding this reservation
start_daterequiredString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.
end_daterequiredString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.
start_timerequiredString in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time)
end_timerequiredString in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time)
cc_typerequiredString describing the type of credit card: amex, visa, mastercard, discover.
cc_numberrequiredString containing the entire credit card number in plaintext
cc_monthrequiredExpiration month of the credit card, 2 digit month.
cc_cscrequiredCard Security Code
cc_yearrequiredExpiration year of the credit card, 4 digit year.
billing_streetrequiredThe billing street address associated with this credit card
billing_cityrequiredThe city associated with this credit card
billing_staterequiredThe state or province associated with this credit card
billing_ziprequiredThe zipcode associated with this credit card
emailoptionalThe email address of the user
billing_suiteoptionalThe second line of the billing address associated with this credit card.
billing_phoneoptionalThe phone number associated with this credit card. Omitting the country code causes USA to be assumed.
use_stored_billingoptionalIf specified, the credit card in cc_number is interpreted as a token rather than a normal credit card. Tokens are similar to credit card numbers but are safe to store. A token is returned for each succesful call. Defaults to false. If included, email and user_token must be included and match an existing pair that was created by a previous call or a call to user.edit_billing
billing_countryoptionalThe country associated with this credit card
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
reservation_idUnique key identifying reservation272329
cc_tokenA PCI-compliant tokenized version of the billing credit card which can be safely stored for later use. It has the same number of digits as the submitted credit card and the last four digits are the same as the submitted credit card1711000104321111
verify_hashThis is a verification code specific to the reservation. It is submitted as an argument to reservation.cancel to ensure that the correct reservation is being cancelled5fbccfdcdac74c383b5981c96c00b1ec

Example Request:

curl -d "use_stored_billing=false&cc_type=Visa&cc_number=4111111111111111&cc_month=05&cc_year=2013&cc_csc=432&billing_firstname=Marvin&billing_lastname=Customer&billing_street=515+Flower&billing_city=Los+Angeles&billing_state=CA&billing_zip=90017&billing_user_id=71840&billing_phone=3105551212&billing_email=aapapitest%40oversee.net&email=aapapitest%40oversee.net&firstname=Marvin&lastname=Customer&start_date=2012-07-01&start_time=12%3A00%3A00&end_date=2012-07-10&end_time=12%3A00%3A00&parking_type_id=1&parking_id=2042&token=YOUR_TOKEN" http://bfudge.apk01.dev.corp.oversee.net/reservation/set

Example Response:

<br />
<b>Warning</b>:  array_key_exists() [
  <a href='function.array-key-exists'>function.array-key-exists</a>
]: The second argument should be either an array or an object in <b>/var/www/aap/api/bfudge/class/reservation.class.php</b> on line <b>1759</b><br />
<br />
<b>Warning</b>:  array_key_exists() [
  <a href='function.array-key-exists'>function.array-key-exists</a>
]: The second argument should be either an array or an object in <b>/var/www/aap/api/bfudge/class/reservation.class.php</b> on line <b>1760</b><br />
<br />
<b>Warning</b>:  array_key_exists() [
  <a href='function.array-key-exists'>function.array-key-exists</a>
]: The second argument should be either an array or an object in <b>/var/www/aap/api/bfudge/class/reservation.class.php</b> on line <b>1761</b><br />
{
  "status":"ok",
  "reservation_id":273924,
  "cc_token":"1711000104321111",
  "verify_hash":"60c766e3dd55b6f141de93e36ba7101d"
}

2.3.3 reservation.calculate

API Explorer: reservation.calculate

Calculate the cost of a parking reservation

This method can calculate reservation costs for one or more parking lots, each with one or more types of parking. Multiple parking lots can be specified by separating parking_id values with commas. Multiple parking types can be specified by separting _parking_type_id values with commas.

If one or more parking_type_id values are not specified then calculations will be done for all parking types supported by the lot.

Note that the output of this method can be automatically combined with parking.list in some cases to improve performance. parking.list could be used with the calculate field group if you wanted to calculate the price of parking in all parking types for all lots around an airport without making multiple API calls.

The results from this method require careful interpretation. Since multiple lots and multiple parking types can be selected, a caller of this method may find that some calculations return an error but other calculations are successful. This can happen in a variety of cases: if a requested type does not exist for a requested lot, if a lot is full, if a lot has a reservation lead time that was not met, and so on.

  • result - returned at parking_id level to notify if lot is in system and at parking_types level to notify if requested parking type is available at that lot and if the lot could take the reservation given current inventory, minimum stay requirements, etc.
    • status - ok or error
    • code - system error code
    • message - explanation of error

Additional information on the fields returned follows:

  • booking_fee - service fee charged by AirportParking
  • booking_discount - discount subtracted from above fee

  • subtotal - cost of reservation, based on lot rates, prior to fees and taxes

  • tax - percent tax levied against subtotal

  • taxdue_ - total amount of tax collected based on above percent

  • fee - one-time fee, charged per reservation (in addition to lot rate)

  • fee_daily - fee amount charged each day of the reservation (in addition to lot rate)

  • fee_daily_total - sum of daily fees -- does not include fee above.

  • deposit - portion collected by AAP in local currency

  • usd_deposit - portion collected by AAP in US dollars

  • amount_due - what customer owes at lot after deposit

  • total - grand total

  • timerate - array explaining how subtotal was calculated based on:

    • cost - amount per unit time
    • duration - amount of unit time
    • timeframe - unit time: hour, day, week, month

Endpoint Information:

HTTP MethodGET
Default Response Fieldsstart_date, end_date, cost, deposit, state, parking_name, parking_address, parking_city, parking_state, parking_phone, shuttle_info, airport_name, fee, fee_daily, fee_daily_total, tax, amount_due, subtotal, booking_fee, booking_discount, parking_type, verify_hash, parking_id, airport_id

Parameters:

tokenrequiredYour API Token
parking_idrequiredThe unique key identfying this parking lot
start_daterequiredString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.
end_daterequiredString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.
start_timerequiredString in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time)
end_timerequiredString in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time)
parking_type_idrequiredA single parking type ID offered by the parking lot
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'
fieldsoptionalA comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned

Available Response Fields:

Field Description Example Value
start_dateString in YYYY-MM-DD format indicating the calendar date of the start of the reservation.2012-03-06
end_dateString in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation.2012-03-06
costCost of reservation in dollars60.00
depositAmount of deposit taken for reservation in dollars5.00
stateState of this reservation, an enumerated type, see section 4.2 for definitions1
parking_nameThe name of the parking facility this reservation is booked atLAX Park
parking_addressThe street address of the parking facility this reservation is booked at8911 Bellanca Ave
parking_cityThe city of the parking facility this reservation is booked atLos Angeles
parking_stateThe state of the parking facility this reservation is booked atCA
parking_phoneThe phone number of the parking facility this reservation is booked at(310) 670-9945
shuttle_infoInformation about shuttle provided by the parking facility the reservation is booked atContinuous shuttle to and from LAX free of charge.
airport_nameThe airport that the parking lot is affiliated withLos Angeles International Airport
feeone-time fee, charged per reservation (in addition to lot rate)1
fee_dailyfee amount charged each day of the reservation (in addition to lot rate)2
fee_daily_totalsum of daily fees -- does not include fee above18
taxpercent tax levied against subtotal10
amount_dueThe amount due by the holder of the reservation upon its use, in dollars55.00
subtotalSubtotal of parking cost, prior to calculation of taxes, in dollars30.00
booking_feeConvenience cost of using reservation system, in dollars5.00
booking_discountDiscount on booking for using reservation system, in dollars5.00
parking_typeDescription of type of parkingOutdoor Valet
verify_hashThis is a verification code specific to the reservation. It is submitted as an argument to reservation.cancel to ensure that the correct reservation is being cancelled5fbccfdcdac74c383b5981c96c00b1ec
parking_idThe unique key identfying this parking lot155
airport_idUnique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code33, LAX, *not* DTT

Example Request:

curl "http://bfudge.apk01.dev.corp.oversee.net/reservation/calculate?token=YOUR_TOKEN&parking_id=2042&start_date=2012-07-01&start_time=12%3A00%3A00&end_date=2012-07-10&end_time=12%3A00%3A00&parking_type_id=1"

Example Response:

{
  "status":"ok",
  "items":{
    "2042":{
      "parking_id":"2042",
      "result":{
        "status":"ok"
      },
      "parking_types":{
        "1":{
          "parking_type_id":"1",
          "parking_type_name":"Outdoor Self Park",
          "calculation":{
            "result":{
              "status":"ok"
            },
            "cost":{
              "booking_fee":5,
              "booking_discount":5,
              "tax":0,
              "fee":0,
              "fee_daily":0,
              "deposit":13.5,
              "subtotal":135,
              "tax_due":0,
              "fee_daily_total":0,
              "usd_deposit":13.5,
              "total":135,
              "amount_due":121.5,
              "timerate":{
                "day":{
                  "cost":15,
                  "duration":9,
                  "timeframe":"day"
                }
              }
            }
          }
        }
      }
    }
  }
}

2.3.4 reservation.cancel

API Explorer: reservation.cancel

Cancels a specific reservation

Endpoint Information:

HTTP MethodPOST
Default Response FieldsNone

Parameters:

tokenrequiredYour API Token
reservation_idrequiredUnique key identifying reservation
emailrequiredThe email address of the user
verify_hashrequiredThis is a verification code specific to the reservation. It is submitted as an argument to reservation.cancel to ensure that the correct reservation is being cancelled
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'

No response fields for this method.

No example available.

2.3.5 reservation.fax

API Explorer: reservation.fax

Faxes the reservation confirmation to the specified fax phone number.

Endpoint Information:

HTTP MethodPOST
Default Response FieldsNone

Parameters:

tokenrequiredYour API Token
reservation_idrequiredUnique key identifying reservation
numberrequiredA phone number
formatoptionalFormat for response: 'json' or 'xml'. Defaults to 'json'

No response fields for this method.

No example available.

2.4 user Methods

2.4.1 user.submit_review

API Explorer: user.submit_review

This method submits a user review for a parking lot.

Endpoint Information:

HTTP MethodPOST
Default Response FieldsNone

Parameters:

tokenrequiredYour API Token
parking_idrequiredThe unique key identfying this parking lot
review_voterequiredUser's vote for this parking lot (1-5 with 5 being best)
review_subjectrequiredSubject of parking lot review
review_commentrequiredBody of parking lot review
codeoptionalA verification code associated with the user
reservation_idoptionalUnique key identifying reservation
emailoptionalThe email address of the user
firstnameoptionalThe first name of the person holding this reservation
lastnameoptionalThe last name of the person holding this reservation

No response fields for this method.

No example available.

2.4.2 user.submit_review_verify

API Explorer: user.submit_review_verify

This method verifys an anonymous user associated with a parking lot review.

Endpoint Information:

HTTP MethodPOST
Default Response FieldsNone

Parameters:

tokenrequiredYour API Token
comment_idrequiredThe unique key for this comment
emailrequiredThe email address of the user
coderequiredA verification code associated with the user

No response fields for this method.

No example available.


3 Resources

3.1 airport

Field Description Example Value
airport_id Unique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code 33, LAX, *not* DTT
airport_code Three letter code identifying airport SFO
airport_name The airport that the parking lot is affiliated with Los Angeles International Airport
airport_latitude Airport's latitude 33.944141
airport_longitude Airport's longitude -118.397450
airport_city City name of airport Phoenix
airport_state_province State abbreviation of airport OR province name CA; Scotland
airport_country_id Unique key identifying country 8
airport_website URL of airport's official website www.lawa.org/lax/welcomeLAX.cfm
compact_name A shortened name for the airport: city + IATA code Southampton (SOU)
count Number of records to return 5
format Format for response: 'json' or 'xml'. Defaults to 'json' json
fields A comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned reservation_id,barcode,amount_due
ip IP address to use for locating airports 134.172.12.10

3.2 parking

Field Description Example Value
calculate (group) Returns a calculation of the cost for each of the types of parking that the parking lot offers. When specifying this requestedField you must also include start_date, start_time, end_date, and end_time arguments This group includes booking_fee, booking_discount, tax, fee, fee_daily, deposit, subtotal, tax_due, fee_daily_total, usd_deposit, total, amount_due, timerate
reviews (group) Returns reviews section for each parking lot This group includes review_comment, review_subject, review_vote, review_title, review_parking_id, review_datetime
parking_types (group) Returns array of parking lot's parking types This group includes parking_type_id, parking_type_name
payment_types (group) A list of payment methods that are accepted by this parking lot. These types are only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types. This group includes payment_type_id, payment_type_name
parking_id The unique key identfying this parking lot 155
airport_id Unique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code 33, LAX, *not* DTT
parking_name The name of the parking facility this reservation is booked at LAX Park
parking_address The street address of the parking facility this reservation is booked at 8911 Bellanca Ave
parking_city The city of the parking facility this reservation is booked at Los Angeles
parking_state The state of the parking facility this reservation is booked at CA
parking_zip Returns the parking lot's zip code 90445
parking_phone The phone number of the parking facility this reservation is booked at (310) 670-9945
country_id Country code of the parking facility 4
direction The direction the parking lot lies with respect to the airport north
distance The parking lot's distance from airport 2.0
parking_latitude Returns the parking lot's latitude 33.948380
parking_longitude Returns the parking lot's longitude -118.396150
shuttle_info Information about shuttle provided by the parking facility the reservation is booked at Continuous shuttle to and from LAX free of charge.
description Parking lot description, may include HTML <p> <b>Please Note:\u00a0 Credit Card payment is the only payment accepted for airport parking...
partnership The parking lot's partnership flag. A value of 100 means a reservation can be made online; other values indicate parking lots that do not accept reservations online. 100
shuttle_wait_time The average shuttle wait time in minutes 19
shuttle_wait_time_count The number of reports of shuttle wait time used to calculate shuttle_wait_time 4
payment_type_names A string indicating payment type IDS that are accepted by this parking lot. It is comma separated. This type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types. Master Card,American Express
payment_type_ids A string indicating payment type IDS that are accepted by this parking lot. It is comma separatedThis type is only used to inform the user what methods are available to pay the balance upon exit from the lot. Deposits are payable with all credit card types. 3,4
parking_rate_count Returns the parking lot's number of customers that rated. If not specififed, no reviews are available for this lot. 6
parking_rate Returns the parking lot's average customer rating. If not specified, no reviews are available for this lot. 2.0
photo_url URL of photo of this parking lot http://www.aboutairportparking.com/files/parking_pics/Picture 064.jpg
top_results_sort_value Returns a score that is used for sorting parking lots. The score is a weighted sum of distance, price, and review ratings 31.203157298226
parking_type_name A single parking type name offerd by the parking lot Covered Valet
parking_type_id A single parking type ID offered by the parking lot 2
parking_type_ids A string indicating parking type IDs offered by the parking lot. It is comma separated if more than one parking type ID exists 1,3
parking_type_names A string indicating parking type names offered by the parking lot. It is comma separated if more than one parking type name exists Outdoor Self,Covered Valet
start_date String in YYYY-MM-DD format indicating the calendar date of the start of the reservation. 2012-03-06
end_date String in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation. 2012-03-06
start_time String in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time) 18:00
end_time String in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time) 18:00
count Number of records to return 5
format Format for response: 'json' or 'xml'. Defaults to 'json' json
fields A comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned reservation_id,barcode,amount_due
photo_count Maximum number of photos to return for parking lot 4
review_count Number of reviews to return, defaults to 3 3
review_timestamp The time of submission of this review 1217628363
review_subject Subject of parking lot review This is a great lot!
review_comment Body of parking lot review Great lot, prompt service!
review_type The type of review: anonymous, registered, verified verified
review_vote User's vote for this parking lot (1-5 with 5 being best) 4
review_parking_id Parking lot id for which the review was written 142

3.3 reservation

Field Description Example Value
reservation_id Unique key identifying reservation 272329
start_date String in YYYY-MM-DD format indicating the calendar date of the start of the reservation. 2012-03-06
end_date String in YYYY-MM-DD format indicating the calendar date and time of the end of the reservation. 2012-03-06
cost Cost of reservation in dollars 60.00
deposit Amount of deposit taken for reservation in dollars 5.00
state State of this reservation, an enumerated type, see section 4.2 for definitions 1
firstname The first name of the person holding this reservation Jane
lastname The last name of the person holding this reservation Smith
email The email address of the user [email protected]
created String in YYYY-MM-DD HH:MM format indicating the calendar date and time of the creation of the reservation. The timezone of the created string is interpreted to be the timezone of the parking lot (local time) 2012-03-06 18:00:00
parking_name The name of the parking facility this reservation is booked at LAX Park
parking_address The street address of the parking facility this reservation is booked at 8911 Bellanca Ave
parking_city The city of the parking facility this reservation is booked at Los Angeles
parking_state The state of the parking facility this reservation is booked at CA
parking_phone The phone number of the parking facility this reservation is booked at (310) 670-9945
shuttle_info Information about shuttle provided by the parking facility the reservation is booked at Continuous shuttle to and from LAX free of charge.
airport_name The airport that the parking lot is affiliated with Los Angeles International Airport
barcode A link to a barcode that can be displayed on a reservation confirmation screen. http://airportparking.com/barcode.php?reservation_id=272329
fee one-time fee, charged per reservation (in addition to lot rate) 1
fee_daily fee amount charged each day of the reservation (in addition to lot rate) 2
fee_daily_total sum of daily fees -- does not include fee above 18
tax percent tax levied against subtotal 10
amount_due The amount due by the holder of the reservation upon its use, in dollars 55.00
subtotal Subtotal of parking cost, prior to calculation of taxes, in dollars 30.00
booking_fee Convenience cost of using reservation system, in dollars 5.00
booking_discount Discount on booking for using reservation system, in dollars 5.00
parking_type Description of type of parking Outdoor Valet
verify_hash This is a verification code specific to the reservation. It is submitted as an argument to reservation.cancel to ensure that the correct reservation is being cancelled 5fbccfdcdac74c383b5981c96c00b1ec
parking_id The unique key identfying this parking lot 155
airport_id Unique key identifying airport. For a parking list request, can be our internal numeric code or an IATA airport code (for a single airport, not a region). For a response, it is always our internal numeric code. See also airport_code 33, LAX, *not* DTT
billing_email The email address of the person paying for this reservation [email protected]
billing_firstname The first name of the person paying for this reservation Ben
billing_lastname The last name of the person requesting this reservation Franklin
billing_street The billing street address associated with this credit card 327 Main Street
billing_suite The second line of the billing address associated with this credit card. Suite 132
billing_city The city associated with this credit card Los Angeles
billing_state The state or province associated with this credit card CA
billing_zip The zipcode associated with this credit card 90071
billing_country The country associated with this credit card USA
format Format for response: 'json' or 'xml'. Defaults to 'json' json
fields A comma separated list of requested fields listed. If fields are specified, only the fields that are requested will be returned. If fields is omitted, the set of default fields will be returned reservation_id,barcode,amount_due
cc_token A PCI-compliant tokenized version of the billing credit card which can be safely stored for later use. It has the same number of digits as the submitted credit card and the last four digits are the same as the submitted credit card 1711000104321111
parking_type_id A single parking type ID offered by the parking lot 2
start_time String in HH:MM format indicating the time of the start of the reservation. The timezone of the start_date string is interpreted to be the timezone of the parking lot (local time) 18:00
end_time String in HH:MM format indicating the time of the end of the reservation. The timezone of the end_date string is interpreted to be the timezone of the parking lot (local time) 18:00
cc_type String describing the type of credit card: amex, visa, mastercard, discover. amex
cc_number String containing the entire credit card number in plaintext 4111111111111111
cc_month Expiration month of the credit card, 2 digit month. 11
cc_csc Card Security Code 123
cc_year Expiration year of the credit card, 4 digit year. 2011
billing_phone The phone number associated with this credit card. Omitting the country code causes USA to be assumed. 8582221212, +64 9 4345563
use_stored_billing If specified, the credit card in cc_number is interpreted as a token rather than a normal credit card. Tokens are similar to credit card numbers but are safe to store. A token is returned for each succesful call. Defaults to false. If included, email and user_token must be included and match an existing pair that was created by a previous call or a call to user.edit_billing false
number A phone number 800-555-1212

3.4 user

Field Description Example Value
parking_id The unique key identfying this parking lot 155
review_vote User's vote for this parking lot (1-5 with 5 being best) 4
review_subject Subject of parking lot review This is a great lot!
review_comment Body of parking lot review Great lot, prompt service!
code A verification code associated with the user 153347f1335313984a0642b0a35f3d382ecd5c41fb59c53bc5
reservation_id Unique key identifying reservation 272329
email The email address of the user [email protected]
firstname The first name of the person holding this reservation Jane
lastname The last name of the person holding this reservation Smith
comment_id The unique key for this comment 12310