Revision as of 15:54, June 20, 2017 by Sbogard (talk | contribs)
Jump to: navigation, search

Sbogard

map-names

Section: business-attributes
Default Value: false
Valid Values: String
Changes Take Effect: Immediately


Set to true to return the Names of Business Attribute Values instead of DB IDs in the responses for GET operations; false (default) to return the DB IDs of Business Attribute Values in the responses for GET operations.

map-names


  1. Click Save WM 851 icon-save.png .
The Modified column displays the date and time of the change.
  1. Click Save WM 851 icon-save.png .
The Modified column displays the date and time of the change.
  1. Click Save WM 851 icon-save.png .
The Modified column displays the date and time of the change.
  • Click Save WM 851 icon-save.png .
The Modified column displays the date and time of the change.


  • Click Save WM 851 icon-save.png .
The Modified column displays the date and time of the change.

h1. Uber API Move your app forward with the Uber API

  • Version:* 1.0.0

{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*}

h2. Endpoints 

   h3. estimatesPriceGet
   {status:colour=Yellow|title=get|subtle=false}
   {code}
   get /estimates/price
   {code}
   *Summary:* Price Estimates
   *Description:* The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.<br><br>The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier. 



   h4. Parameters



       h5. Query Parameters
       ||Name||Description||Required||Default||Pattern||
       |startLatitude |Latitude component of start location. |(/) | |  |

|startLongitude |Longitude component of start location. |(/) | | | |endLatitude |Latitude component of end location. |(/) | | | |endLongitude |Longitude component of end location. |(/) | | | 



   h4. Responses
       *Status Code:* 200
       *Message:*     An array of price estimates by product
       {code:title=Response Type}

array[inline_response_200_1] 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "An array of price estimates by product",
 "schema" : {
   "type" : "array",
   "items" : {
     "$ref" : "#/definitions/inline_response_200_1"
   }
 }

} 

       {code}
       *Status Code:* 0
       *Message:*     Unexpected error
       {code:title=Response Type}

inline_response_default 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Unexpected error",
 "schema" : {
   "$ref" : "#/definitions/inline_response_default"
 }

} 

       {code}
   ----

   h3. estimatesTimeGet
   {status:colour=Yellow|title=get|subtle=false}
   {code}
   get /estimates/time
   {code}
   *Summary:* Time Estimates
   *Description:* The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.



   h4. Parameters



       h5. Query Parameters
       ||Name||Description||Required||Default||Pattern||
       |startLatitude |Latitude component of start location. |(/) | |  |

|startLongitude |Longitude component of start location. |(/) | | | |customerUuid |Unique customer identifier to be used for experience customization. |(x) | | | |productId |Unique identifier representing a specific product for a given latitude & longitude. |(x) | | | 



   h4. Responses
       *Status Code:* 200
       *Message:*     An array of products
       {code:title=Response Type}

array[inline_response_200] 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "An array of products",
 "schema" : {
   "type" : "array",
   "items" : {
     "$ref" : "#/definitions/inline_response_200"
   }
 }

} 

       {code}
       *Status Code:* 0
       *Message:*     Unexpected error
       {code:title=Response Type}

inline_response_default 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Unexpected error",
 "schema" : {
   "$ref" : "#/definitions/inline_response_default"
 }

} 

       {code}
   ----

   h3. productsGet
   {status:colour=Yellow|title=get|subtle=false}
   {code}
   get /products
   {code}
   *Summary:* Product Types
   *Description:* The Products endpoint returns information about the *Uber* products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order. 



   h4. Parameters



       h5. Query Parameters
       ||Name||Description||Required||Default||Pattern||
       |latitude |Latitude component of location. |(/) | |  |

|longitude |Longitude component of location. |(/) | | | 



   h4. Responses
       *Status Code:* 200
       *Message:*     An array of products
       {code:title=Response Type}

array[inline_response_200] 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "An array of products",
 "schema" : {
   "type" : "array",
   "items" : {
     "$ref" : "#/definitions/inline_response_200"
   }
 }

} 

       {code}
       *Status Code:* 0
       *Message:*     Unexpected error
       {code:title=Response Type}

inline_response_default 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Unexpected error",
 "schema" : {
   "$ref" : "#/definitions/inline_response_default"
 }

} 

       {code}
   ----

   h3. historyGet
   {status:colour=Yellow|title=get|subtle=false}
   {code}
   get /history
   {code}
   *Summary:* User Activity
   *Description:* The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.



   h4. Parameters



       h5. Query Parameters
       ||Name||Description||Required||Default||Pattern||
       |offset |Offset the list of returned results by this amount. Default is zero. |(x) | |  |

|limit |Number of items to retrieve. Default is 5, maximum is 100. |(x) | | | 



   h4. Responses
       *Status Code:* 200
       *Message:*     History information for the given user
       {code:title=Response Type}

inline_response_200_3 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "History information for the given user",
 "schema" : {
   "$ref" : "#/definitions/inline_response_200_3"
 }

} 

       {code}
       *Status Code:* 0
       *Message:*     Unexpected error
       {code:title=Response Type}

inline_response_default 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Unexpected error",
 "schema" : {
   "$ref" : "#/definitions/inline_response_default"
 }

} 

       {code}
   ----

   h3. meGet
   {status:colour=Yellow|title=get|subtle=false}
   {code}
   get /me
   {code}
   *Summary:* User Profile
   *Description:* The User Profile endpoint returns information about the Uber user that has authorized with the application.



   h4. Parameters





   h4. Responses
       *Status Code:* 200
       *Message:*     Profile information for a user
       {code:title=Response Type}

inline_response_200_2 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Profile information for a user",
 "schema" : {
   "$ref" : "#/definitions/inline_response_200_2"
 }

} 

       {code}
       *Status Code:* 0
       *Message:*     Unexpected error
       {code:title=Response Type}

inline_response_default 

       {code}
       See [#models]



       {code:title=Response Schema |collapse=true}

{ 

 "description" : "Unexpected error",
 "schema" : {
   "$ref" : "#/definitions/inline_response_default"
 }

} 

       {code}
   ----

h2. Models 

       h3. Activities
       ||Field Name||Required||Type||Description||
        |offset | |Integer |Position in pagination. |
|limit | |Integer |Number of items to retrieve (100 max). |
|count | |Integer |Total number of items available. |
|history | |array[inline_response_200_3_history] | |
       h3. Activity
       ||Field Name||Required||Type||Description||
        |uuid | |String |Unique identifier for the activity |
       h3. Error
       ||Field Name||Required||Type||Description||
        |code | |Integer | |
|message | |String | |
|fields | |String | |
       h3. Inline_response_200
       ||Field Name||Required||Type||Description||
        |product_id | |String |Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles. |
|description | |String |Description of product. |
|display_name | |String |Display name of product. |
|capacity | |String |Capacity of product. For example, 4 people. |
|image | |String |Image URL representing the product. |
       h3. Inline_response_200_1
       ||Field Name||Required||Type||Description||
        |product_id | |String |Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles |
|currency_code | |String |[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code. |
|display_name | |String |Display name of product. |
|estimate | |String |Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or \"Metered\" for TAXI. |
|low_estimate | |BigDecimal |Lower bound of the estimated price. |
|high_estimate | |BigDecimal |Upper bound of the estimated price. |
|surge_multiplier | |BigDecimal |Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier. |
       h3. Inline_response_200_2
       ||Field Name||Required||Type||Description||
        |first_name | |String |First name of the Uber user. |
|last_name | |String |Last name of the Uber user. |
|email | |String |Email address of the Uber user |
|picture | |String |Image URL of the Uber user. |
|promo_code | |String |Promo code of the Uber user. |
       h3. Inline_response_200_3
       ||Field Name||Required||Type||Description||
        |offset | |Integer |Position in pagination. |
|limit | |Integer |Number of items to retrieve (100 max). |
|count | |Integer |Total number of items available. |
|history | |array[inline_response_200_3_history] | |
       h3. Inline_response_200_3_history
       ||Field Name||Required||Type||Description||
        |uuid | |String |Unique identifier for the activity |
       h3. Inline_response_default
       ||Field Name||Required||Type||Description||
        |code | |Integer | |
|message | |String | |
|fields | |String | |
       h3. PriceEstimate
       ||Field Name||Required||Type||Description||
        |product_id | |String |Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles |
|currency_code | |String |[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code. |
|display_name | |String |Display name of product. |
|estimate | |String |Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or \"Metered\" for TAXI. |
|low_estimate | |BigDecimal |Lower bound of the estimated price. |
|high_estimate | |BigDecimal |Upper bound of the estimated price. |
|surge_multiplier | |BigDecimal |Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier. |
       h3. Product
       ||Field Name||Required||Type||Description||
        |product_id | |String |Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles. |
|description | |String |Description of product. |
|display_name | |String |Display name of product. |
|capacity | |String |Capacity of product. For example, 4 people. |
|image | |String |Image URL representing the product. |
       h3. Profile
       ||Field Name||Required||Type||Description||
        |first_name | |String |First name of the Uber user. |
|last_name | |String |Last name of the Uber user. |
|email | |String |Email address of the Uber user |
|picture | |String |Image URL of the Uber user. |
|promo_code | |String |Promo code of the Uber user. |
Comments or questions about this documentation? Contact us for support!