Get bookings

Provides a list of all current bookings of a user. Access to this function is restricted. See OAuth documentation for more details.

Parameters

Request Examples

 GET https://www.car2go.com/api/v2.1/bookings?loc=ulm&format=json
 

 GET https://www.car2go.com/api/v2.1/bookings?loc=austin
 

Response

Each booking consists of

• returnValue - see list of return codes below and return values for more details
• a unique booking Id
• a reservation time: date time string, according to ISO 8601, e.g. 2010-01-21T13:05+01:00
• a booking position: longitude and latitude of booking
• account information: id and description of the account which will be charged
• and vehicle information (optional, depends on whether a vehicles has already been assigned or not)

Vehicle information consists of

• vin unique, textual vehicle identifier
• numberPlate number plate of vehicle, e.g. used to identify car on the street
• fuel level
• interior
• exterior
• position: longitude and latitude of vehicle
• engineType: CE for CombustionEngine, ED for ElectricDrive
• charging: true/false for ElectricDrive vehicles

Response Examples

A XML response example:

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <bookingResponse xmlns="http://www.car2go.com/openapi/xmlschema">
     <returnValue>
         <code>0</code>
         <description>Operation successful.</description>
     </returnValue>  
     <booking>
         <bookingId>4321</bookingId>
         <reservationTime>2001-12-31T12:00:00+01:00</reservationTime>
         <bookingposition>
             <latitude>48.4008</latitude>
             <longitude>9.9596</longitude>
             <address>Blaubeurer Strasse 128, 89077 Ulm</address>
         </bookingposition>
         <account>    
             <accountId>5678</accountId>
             <description>Max Mustermann</description>    
         </account>
         <vehicle>
             <vin>WME4513001K154451</vin>
             <numberPlate>UL-C5713</numberPlate>
             <fuel>90</fuel> 
             <interior>GOOD</interior> 
             <exterior>GOOD</exterior> 
             <position>
                 <latitude>48.4008</latitude>
                 <longitude>9.9596</longitude>
                 <address>Blaubeurer Strasse 128, 89077 Ulm</address>
             </position>
             <engineType>CE</engineType>
         </vehicle>
     </booking>  
     <booking>
         <bookingId>4321</bookingId>
         <reservationTime>2001-12-31T13:00:00+01:00</reservationTime>
         <bookingposition>
             <latitude>48.1048</latitude>
             <longitude>8.1591</longitude>
             <address>Lange Strasse 67, 82828 Grossstadt</address>
         </bookingposition>
         <account>
             <accountId>5678</accountId>
             <description>Max Mustermann</description>    
         </account> 
     </booking>
 </bookingResponse>
 

A JSON example:

 {"booking":[{
    "account":{"accountId":1002,"description":"Max Mustermann1002"},
    "bookingId":2910,
    "bookingposition":{"address":"Daimler Mitarbeiterparkplatz, Wilhelm-Runge-Strasse","latitude":48.423291,"longitude":9.939559},
    "reservationTime":{"firstDayOfWeek":1,"gregorianChange":"1582-10-15","lenient":true,"minimalDaysInFirstWeek":1,"time":"2010-01-02","timeInMillis":1325501991033,"timeZone":{"DSTSavings":3600000,"ID":"Europe/Berlin","dirty":false,"displayName":"Central European Time","lastRuleInstance":{"DSTSavings":3600000,"ID":"Europe/Berlin","displayName":"Central European Time","rawOffset":3600000},"rawOffset":3600000}},
    "vehicle":{
      "engineType":"CE",
      "exterior":"GOOD",
      "fuel":90,
      "interior":"GOOD",
      "numberPlate":"UL-C1010",
      "position":{
        "address":"Wilhelm-Runge-Strasse 10, 89081 Ulm",
        "latitude":48.42188,
        "longitude":9.9411
      },
      "vin":"WME0000000K000010"}
  },{...second booking...}
  ],
  "returnValue":{
    "code":0,
    "description":"Operation successful."
  }}
 

Test Mode

Response contains two bookings, one for each test account. The first one has a vehicle assigned, the second one is scheduled in future. Note: Bookings created in test mode won't be returned.

Return Codes

The following return codes may occur:

(c) 2010 car2go GmbH. All rights reserved. Generated 03.02.12 08:59