-
Notifications
You must be signed in to change notification settings - Fork 13
/
userActivity.raml
46 lines (44 loc) · 2.08 KB
/
userActivity.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#%RAML 0.8
title: Uber user activity
version: v1.2
baseUri: https://{apiMode}.uber.com/{version}
baseUriParameters:
apiMode:
description: In order to use the Sandbox environment set 'sandbox-api'. Otherwise set 'api'.
enum: [ sandbox-api, api ]
securitySchemes:
- oauth_2_0: !include securitySchemes/oauth_2_0.raml
- bearer: !include securitySchemes/bearer.raml
schemas:
- userHistoryResponse: !include schemas/userHistoryResponse-schema.json
securedBy: [ oauth_2_0 ]
/history:
description: |
The User Activity endpoint returns a limited amount of data about a user's lifetime activity with Uber. The response will include pickup and dropoff times, the city the trips took place in, the distance of past requests, and information about which products were requested.
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.
get:
description: |
The User Activity endpoint returns a limited amount of data about a user's lifetime activity with Uber. The response will include pickup and dropoff times, the city the trips took place in, the distance of past requests, and information about which products were requested.
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.
queryParameters:
offset:
description: Offset the list of returned results by this amount. Default is zero.
type: integer
required: true
default: 0
example: 2
limit:
description: Number of items to retrieve. Default is 5, maximum is 50.
type: integer
required: true
default: 5
example: 20
responses:
200:
body:
application/json:
schema: userHistoryResponse
example: !include examples/userHistoryResponse-example.json
documentation:
- title: Headline
content: !include docs/userActivity/headline.md