-
-
Save briandilley/5af65e9c0726004a4f234a1a2ea9f3e0 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swagger: '2.0' | |
info: | |
description: APIs for integration the Quickride Shuttle Management Platform | |
version: '1.0' | |
title: Quickride Platform Integration API | |
termsOfService: 'https://goquickride.com/terms' | |
contact: | |
name: Customer Service | |
url: 'http://goquickride.com' | |
email: info@goquickride.com | |
license: | |
name: CUSTOM | |
url: 'https://goquickride.com/' | |
host: 'ntegration-api.goquickride.com' | |
basePath: / | |
tags: | |
- name: Quickride Integration API | |
description: All APIs relating to the integration of the Quickride platform | |
- name: shuttle-ride-controller | |
description: Shuttle Ride Controller | |
consumes: | |
- application/x-www-form-urlencoded | |
produces: | |
- application/json | |
paths: | |
/api/v1/rides: | |
get: | |
tags: | |
- shuttle-ride-controller | |
summary: List Shuttle Rides | |
description: Returns a paginated list of shuttle rides | |
operationId: getShuttleRidesUsingGET | |
parameters: | |
- name: states | |
in: query | |
description: states | |
required: false | |
type: array | |
items: | |
type: string | |
enum: | |
- WAITING_FOR_PICKUP | |
- EN_ROUTE | |
- FINISHED | |
- CANCELED | |
collectionFormat: multi | |
enum: | |
- WAITING_FOR_PICKUP | |
- EN_ROUTE | |
- FINISHED | |
- CANCELED | |
- name: cursor | |
in: query | |
description: cursor | |
required: false | |
type: string | |
- name: limit | |
in: query | |
description: limit | |
required: false | |
type: integer | |
default: 50 | |
format: int64 | |
responses: | |
'200': | |
description: OK | |
schema: | |
$ref: '#/definitions/PagedResultResponse%C2%ABShuttleRideResponse%C2%BB' | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
post: | |
tags: | |
- shuttle-ride-controller | |
summary: Create Shuttle Ride | |
description: Creates a new shuttle ride | |
operationId: createShuttleRideUsingPOST | |
parameters: | |
- name: fromLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: fromLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: passengerName | |
in: query | |
required: false | |
type: string | |
- name: passengerPhoneNumber | |
in: query | |
required: false | |
type: string | |
- name: fromAddress | |
in: query | |
required: false | |
type: string | |
- name: toAddress | |
in: query | |
required: false | |
type: string | |
- name: warranty | |
in: query | |
required: false | |
type: boolean | |
- name: referenceNumber | |
in: query | |
required: false | |
type: string | |
- name: notes | |
in: query | |
required: false | |
type: string | |
- name: dateActive | |
in: query | |
required: false | |
type: string | |
responses: | |
'200': | |
description: OK | |
schema: | |
$ref: '#/definitions/ShuttleRideResponse' | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
'/api/v1/rides/{rideId}': | |
get: | |
tags: | |
- shuttle-ride-controller | |
summary: Get Shuttle Ride | |
description: Retreives a shuttle ride by it's id | |
operationId: getShuttleRideUsingGET | |
parameters: | |
- name: rideId | |
in: path | |
description: rideId | |
required: true | |
type: integer | |
format: int64 | |
responses: | |
'200': | |
description: OK | |
schema: | |
$ref: '#/definitions/ShuttleRideResponse' | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
put: | |
tags: | |
- shuttle-ride-controller | |
summary: Update Shuttle Ride | |
description: Updates a shuttle ride in whole | |
operationId: updateShuttleRideUsingPUT | |
parameters: | |
- name: rideId | |
in: path | |
description: rideId | |
required: true | |
type: integer | |
format: int64 | |
- name: fromLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: fromLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: passengerName | |
in: query | |
required: false | |
type: string | |
- name: passengerPhoneNumber | |
in: query | |
required: false | |
type: string | |
- name: fromAddress | |
in: query | |
required: false | |
type: string | |
- name: toAddress | |
in: query | |
required: false | |
type: string | |
- name: warranty | |
in: query | |
required: false | |
type: boolean | |
- name: referenceNumber | |
in: query | |
required: false | |
type: string | |
- name: notes | |
in: query | |
required: false | |
type: string | |
- name: dateActive | |
in: query | |
required: false | |
type: string | |
responses: | |
'200': | |
description: OK | |
schema: | |
$ref: '#/definitions/ShuttleRideResponse' | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
delete: | |
tags: | |
- shuttle-ride-controller | |
summary: Cancel Shuttle Ride | |
description: Cancels an existing shuttle ride | |
operationId: cancelShuttleRideUsingDELETE | |
parameters: | |
- name: rideId | |
in: path | |
description: rideId | |
required: true | |
type: integer | |
format: int64 | |
responses: | |
'200': | |
description: OK | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
patch: | |
tags: | |
- shuttle-ride-controller | |
summary: Patch Shuttle Ride | |
description: Updates a shuttle ride in partial | |
operationId: patchShuttleRideUsingPATCH | |
parameters: | |
- name: rideId | |
in: path | |
description: rideId | |
required: true | |
type: integer | |
format: int64 | |
- name: fromLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: fromLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLat | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: toLon | |
in: query | |
required: false | |
type: number | |
format: double | |
- name: passengerName | |
in: query | |
required: false | |
type: string | |
- name: passengerPhoneNumber | |
in: query | |
required: false | |
type: string | |
- name: fromAddress | |
in: query | |
required: false | |
type: string | |
- name: toAddress | |
in: query | |
required: false | |
type: string | |
- name: warranty | |
in: query | |
required: false | |
type: boolean | |
- name: referenceNumber | |
in: query | |
required: false | |
type: string | |
- name: notes | |
in: query | |
required: false | |
type: string | |
- name: dateActive | |
in: query | |
required: false | |
type: string | |
responses: | |
'200': | |
description: OK | |
schema: | |
$ref: '#/definitions/ShuttleRideResponse' | |
headers: | |
Accept: | |
schema: | |
type: string | |
description: Indicates which MIME types the client is capable of understanding. During content negotiation, the server should select which of the MIME types for the response. That choice is communicated back to the client using the Content-Type response header.. | |
Accept-Charset: | |
schema: | |
type: string | |
description: Indicates which character sets the requesting client is is capable of understanding. | |
Accept-Encoding: | |
schema: | |
type: string | |
description: Indicates which encoding schemes the requesting client is capable of understanding. | |
Accept-Language: | |
schema: | |
type: string | |
description: Indicates which local language representations of resources client is capable of understanding. | |
Authorization: | |
schema: | |
type: string | |
description: Specifies the credentials of the client to authenticate with a service. | |
If-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values. | |
If-None-Match: | |
schema: | |
type: string | |
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values. | |
Prefer: | |
schema: | |
type: string | |
description: For query responses when return=minimal services must return only the required properties of returned resources as per their defined schema. When return=representation services must return all properties of returned resources as per their defined schema. For create and update when return=minimal services must return only the LinkDescriptionObject of the created/updated resource in the response. When return=representation services must return a complete representation of the resource in the response. | |
Subscription-Id: | |
schema: | |
type: string | |
description: Specifies the Fortellis Marketplace customer subscription request. | |
Content-Encoding: | |
schema: | |
type: string | |
description: Specifies the encoding of the response body. | |
Content-Language: | |
schema: | |
type: string | |
description: Specifies the local language of returned content. | |
Content-Type: | |
schema: | |
type: string | |
description: Specifies the MIME Type of the response. | |
ETag: | |
schema: | |
type: string | |
description: Provides a unique identifier for a specific version of a resource. This allows downstream service applications to cache resources efficiently. When a resource changes a new ETag value should be generated and included in future responses. | |
Preference-Applied: | |
schema: | |
type: string | |
description: Indicates the applied preferences requested using the Prefer request header. | |
Request-Id: | |
schema: | |
type: string | |
description: Specifies the unique identifier of the originating request. | |
security: | |
- X-Quickride-ApiKey: [] | |
securityDefinitions: | |
X-Quickride-ApiKey: | |
type: apiKey | |
name: X-Quickride-ApiKey | |
in: header | |
definitions: | |
LocationResponse: | |
type: object | |
properties: | |
address: | |
type: string | |
point: | |
$ref: '#/definitions/PointResponse' | |
title: LocationResponse | |
PagedResultResponse«ShuttleRideResponse»: | |
type: object | |
properties: | |
cursor: | |
$ref: '#/definitions/PaginationCursorResponse' | |
results: | |
type: array | |
items: | |
$ref: '#/definitions/ShuttleRideResponse' | |
title: PagedResultResponse«ShuttleRideResponse» | |
PaginationCursorResponse: | |
type: object | |
properties: | |
hasMore: | |
type: boolean | |
next: | |
type: string | |
size: | |
type: integer | |
format: int32 | |
title: PaginationCursorResponse | |
PointResponse: | |
type: object | |
properties: | |
lat: | |
type: number | |
format: double | |
lon: | |
type: number | |
format: double | |
title: PointResponse | |
ShuttleRideResponse: | |
type: object | |
properties: | |
associateUser: | |
$ref: '#/definitions/StationUserResponse' | |
createdByUser: | |
$ref: '#/definitions/StationUserResponse' | |
dateActive: | |
type: string | |
dateCreated: | |
type: string | |
dateUpdated: | |
type: string | |
deviceId: | |
type: integer | |
format: int64 | |
driverUser: | |
$ref: '#/definitions/StationUserResponse' | |
dropOffEta: | |
type: string | |
dropOffLocation: | |
$ref: '#/definitions/LocationResponse' | |
id: | |
type: integer | |
format: int64 | |
notes: | |
type: string | |
organizationId: | |
type: integer | |
format: int64 | |
originalDropOffEta: | |
type: string | |
originalPickupEta: | |
type: string | |
passengerName: | |
type: string | |
passengerPhoneNumber: | |
type: string | |
pickupEta: | |
type: string | |
pickupLocation: | |
$ref: '#/definitions/LocationResponse' | |
referenceNumber: | |
type: string | |
shuttleId: | |
type: integer | |
format: int64 | |
stationId: | |
type: integer | |
format: int64 | |
status: | |
type: string | |
enum: | |
- WAITING_FOR_PICKUP | |
- EN_ROUTE | |
- FINISHED | |
- CANCELED | |
warranty: | |
type: boolean | |
title: ShuttleRideResponse | |
StationUserResponse: | |
type: object | |
properties: | |
dateCreated: | |
type: string | |
dateUpdated: | |
type: string | |
displayName: | |
type: string | |
emailAddress: | |
type: string | |
enabled: | |
type: boolean | |
id: | |
type: integer | |
format: int64 | |
organizationId: | |
type: integer | |
format: int64 | |
phoneNumber: | |
type: string | |
photoUrl: | |
type: string | |
roles: | |
type: array | |
items: | |
type: string | |
enum: | |
- USER | |
- ADMIN | |
stationId: | |
type: integer | |
format: int64 | |
username: | |
type: string | |
title: StationUserResponse | |
PatchShuttleRideRequest: | |
type: object | |
properties: | |
dateActive: | |
type: string | |
notes: | |
type: string | |
passengerName: | |
type: string | |
passengerPhoneNumber: | |
type: string | |
toLat: | |
type: number | |
toLon: | |
type: number | |
toAddress: | |
type: string | |
fromLat: | |
type: number | |
fromLon: | |
type: number | |
fromAddress: | |
type: string | |
warranty: | |
type: boolean | |
referenceNumber: | |
type: string | |
title: PatchShuttleRideRequest |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment