Get booking

Provides the detailed information of a recently booked vehicle for the current user. The vehicle must have been assigned to the authenticated user. Access to this function is restricted. See OAuth documentation for more details.

Access:	protected
URL:	https://www.car2go.com/api/v2.1/booking
Method:	GET

Parameters

Name	Mandatory	Description
loc	true	location identifier string of the user's home location, e.g. "ulm", "austin".
format	false	defines response format. Value "json" => JSON format, otherwise xml format is used
callback	false	defines JSONP (JSON with Padding) callback function used as wrapper
test	false	activates test mode if set to "1". See below for more details.

Request Examples

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

GET https://www.car2go.com/api/v2.1/booking?loc=ulm

Response

Booking details of the current reserved car 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

detailed vehicle information (optional, depends on whether a vehicles has already been assigned or not)

vin unique, textual vehicle identifier

numberPlate number plate of vehicle, e.g. used to identify car on the streetr

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 of reserved vehicle:

 <?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>2910</bookingId> 
         <reservationTime>2010-03-29T09:00:00+01:00</reservationTime> 
         <bookingposition>
             <latitude>48.423291</latitude> 
             <longitude>9.939559</longitude> 
             <address>Daimler Mitarbeiterparkplatz, Wilhelm-Runge-Strasse</address> 
         </bookingposition>
         <account>
             <accountId>1002</accountId> 
             <description>Max Mustermann1002</description> 
         </account>
         <vehicle>
             <vin>WME0000000K000010</vin> 
             <numberPlate>UL-C1010</numberPlate> 
             <fuel>90</fuel> 
             <interior>GOOD</interior> 
             <exterior>GOOD</exterior> 
             <position>
                 <latitude>48.42188</latitude> 
                 <longitude>9.9411</longitude> 
                 <address>Wilhelm-Runge-Strasse 10, 89081 Ulm</address>
             </position>
             <engineType>CE</engineType>             
         </vehicle>
     </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"}
  }],
  "returnValue":{
    "code":0,
    "description":"Operation successful."
  }}

Test Mode

Response contains one booking for one of the test accounts.

Return Codes

The following return codes may occur:

Code	Description	Note
0	Operation successful.
1	Location invalid.
3	No valid accounts found.	The user has no valid accounts. This occurs when the user has no account and is not invited to any accounts.
4	Not all necessary url parameters provided.
5	A technical error occured.	This error can occur in case of application problems. If this error persist, please report the bug.
12	No reserved vehicle found.

► Sign in to add a comment