API Document

#Exchange Mobile API ## HTTP | HTTPS://seatsx.com/exchange-mobileapi **Version** v1 # APIs ## /exchange-mobileapi/accountBalance ### GET <a id="get">User account balance</a> #### Security * Bearer Token #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/AccountBalanceResponse">AccountBalanceResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/all/{communityType}/{pageNumber}/{pageSize} ### GET <a id="getall">All communities</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>communityType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>pageNumber</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> <tr> <th>pageSize</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesResponse">CommunitiesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/followed/{communityType} ### GET <a id="getfollowed">All followed communities</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>communityType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesResponse">CommunitiesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/prices ### GET <a id="lastPrices">Communities last prices</a> #### Security * Bearer Token #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesPricesResponse">CommunitiesPricesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/recommended/{communityType}/{pageNumber}/{pageSize} ### POST <a id="recommended">Recommended communities</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>communityType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>pageNumber</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> <tr> <th>pageSize</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/GetCommunitiesRequest">GetCommunitiesRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesResponse">CommunitiesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/search/{communityType}/{query}/{pageNumber}/{pageSize} ### GET <a id="search">Search communities</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>communityType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>query</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>pageNumber</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> <tr> <th>pageSize</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesResponse">CommunitiesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/communities/searchByHub/{communityType}/{query}/{pageNumber}/{pageSize} ### GET <a id="searchByHub">Search communities</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>communityType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>query</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>pageNumber</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> <tr> <th>pageSize</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunitiesResponse">CommunitiesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comment/delete/{id} ### GET <a id="deleteComment">Delete community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comment/dislike/{id} ### GET <a id="dislikeComment">Dislike community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/LikeResponse">LikeResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comment/like/{id} ### GET <a id="likeComment">Like community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/LikeResponse">LikeResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comment/post ### POST <a id="post">Post a community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/PostCommunityCommentRequest">PostCommunityCommentRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comment/replies/{id} ### GET <a id="getCommentReplies">Get community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/GetCommunityCommentsResponse">GetCommunityCommentsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/comments/get/{id} ### GET <a id="getCommunityComments">Get community comments</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/GetCommunityCommentsResponse">GetCommunityCommentsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/follow/{id} ### GET <a id="follow">Follow community</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunityFollowResponse">CommunityFollowResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/unfollow/{id} ### GET <a id="unfollow">Unfollow community</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/community/{id} ### GET <a id="getCommunity">Get commute community</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/CommunityDetailsResponse">CommunityDetailsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/emergency/call ### GET <a id="call">Emergency Call</a> #### Security * Bearer Token #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/emergency/call/{tripId} ### GET <a id="calltrip">Emergency Call</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tripId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/emergency/video ### POST <a id="video">Upload video</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/Picture">Picture</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/emergency/video/{tripId} ### POST <a id="videotrip">Upload video</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tripId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/Picture">Picture</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/exchangetypes ### GET <a id="getMessage">Exchange types</a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ExchangeTypesResponse">ExchangeTypesResponse</a>| ## /exchange-mobileapi/highestTrading ### POST <a id="post">Highest trading pair</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/HighestTradingRequest">HighestTradingRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/HighestTradingResponse">HighestTradingResponse</a>| ## /exchange-mobileapi/hubs/get ### POST <a id="get">Get hubs close to location</a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/GetHubsRequest">GetHubsRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/GetHubsResponse">GetHubsResponse</a>| ## /exchange-mobileapi/hubs/orderdata/{hubId} ### GET <a id="orderdata">Get hub order data</a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>hubId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/HubOrderDataResponse">HubOrderDataResponse</a>| ## /exchange-mobileapi/location/update ### POST <a id="post">Trop location update</a> #### Security * Bearer Token #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/LocationUpdateRequest">LocationUpdateRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/LocationUpdateResponse">LocationUpdateResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/login ### POST <a id="login">User login</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/LoginRequest">LoginRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/LoginResponse">LoginResponse</a>| | 403 | Invalid user name or password | - | ## /exchange-mobileapi/login/recovery ### POST <a id="recovery">User id and password recovery</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/LoginRecoveryRequest">LoginRecoveryRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| ## /exchange-mobileapi/logout ### GET <a id="logout">User logout</a> #### Security * Bearer Token #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/orders/delete/{id} ### GET <a id="delete">Delete order</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/orders/find ### POST <a id="find">Find orders for route</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/FindOrdersRequest">FindOrdersRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/FindOrdersResponse">FindOrdersResponse</a>| ## /exchange-mobileapi/orders/get/{hubType} ### GET <a id="get">User open orders</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>hubType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/OrdersResponse">OrdersResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/orders/place ### POST <a id="place">Place new order</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/PlaceOrderRequest">PlaceOrderRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PlaceOrderResponse">PlaceOrderResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/paypal/checkout ### POST <a id="checkout">Paypal checkout</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/PaypalCheckoutRequest">PaypalCheckoutRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/AccountBalanceResponse">AccountBalanceResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/paypal/configuration ### GET <a id="configuration">Paypal configuration</a> #### Security * Bearer Token #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PaypalConfigurationResponse">PaypalConfigurationResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/paypal/payment ### POST <a id="payment">Paypal payment</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/PaypalPaymentRequest">PaypalPaymentRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/AccountBalanceResponse">AccountBalanceResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/route/delete/{id} ### GET <a id="deleteroute">Delete user route</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/route/notifications ### POST <a id="updateNotifications">Update route notifications</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/UpdateNotificationsRequest">UpdateNotificationsRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/route/{id} ### GET <a id="getroute">Get user route</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/UserRouteResponse">UserRouteResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/routes/{hubType} ### GET <a id="getroutes">Get active user routes</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>hubType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/UserRoutesResponse">UserRoutesResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/signup ### POST <a id="userSignup">New user signup</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/SignupRequest">SignupRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| ## /exchange-mobileapi/signup/driver ### POST <a id="driverSignup">driver register</a> #### Security * Bearer #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/DriverSignupRequest">DriverSignupRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/stripe/payment/intent ### POST <a id="intent">Create Stripe payment intent</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/StripePaymentRequest">StripePaymentRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/StripePaymentResponse">StripePaymentResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/stripe/payment/verify ### POST <a id="verify">Verify Stripe payment</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/StripePaymentVerifyRequest">StripePaymentVerifyRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/StripePaymentVerifyResponse">StripePaymentVerifyResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/message ### POST <a id="send">Send trip message</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/TripMessageRequest">TripMessageRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/message/{id} ### GET <a id="getMessage">Trip message</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripMessages">TripMessages</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/messages/{id} ### GET <a id="get">Trip messages</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripMessages">TripMessages</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/add ### POST <a id="add">Add trip stop</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/TripStop">TripStop</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ResponseWithId">ResponseWithId</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/complete/{id} ### GET <a id="complete">Complete trip stop</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/delete/{id} ### GET <a id="delete">Delete trip stop</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/get/{id} ### GET <a id="get">Trip stop details</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripStopDetailsResponse">TripStopDetailsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/picture/add/{id} ### POST <a id="addPicture">Add picture to trip stop</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/Picture">Picture</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ResponseWithId">ResponseWithId</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/picture/delete/{stopId}/{picId} ### GET <a id="deletePicture">Delete trip stop picture</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>stopId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>picId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/picture/{id} ### GET <a id="getPicture">Trip picture</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/PictureResponse">PictureResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/requestConfirmation/{id} ### GET <a id="requestConfirmation">Request trip stop confirmation</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stop/review ### POST <a id="review">Post trip stop review</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/TripStopReview">TripStopReview</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ResponseWithId">ResponseWithId</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stops/getall/{id} ### GET <a id="getall">Trip stops</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripStopsResponse">TripStopsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trip/stops/reorder ### POST <a id="reorderStops">Reorder trip stops</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/StopsReorderRequest">StopsReorderRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/BaseResponse">BaseResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trips/past/{hubType} ### GET <a id="getPast">User trips</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>hubType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripsResponse">TripsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/trips/upcoming/{hubType} ### GET <a id="getUpcoming">User upcoming trips</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>hubType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/TripsResponse">TripsResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/withdrawal ### POST <a id="getUpcoming">Acount withdrawal</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/WithdrawalRequest">WithdrawalRequest</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/WithdrawalResponse">WithdrawalResponse</a>| | 401 | Missing or invalid authorization | - | ## /exchange-mobileapi/zoom/meeting/{id} ### GET <a id="getZoomMeating">Zoom meeting info</a> #### Security * Bearer Token #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ZoomMeetingDataResponse">ZoomMeetingDataResponse</a>| | 401 | Missing or invalid authorization | - | # Definitions ## <a name="/definitions/AccountBalanceResponse">AccountBalanceResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>balance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>availableBalance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Address">Address</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>country</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>city</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>addressLine1</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>addressLine2</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>state</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>zip</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>building</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/BaseResponse">BaseResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunitiesPricesResponse">CommunitiesPricesResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>communities</td> <td> array[<a href="#/definitions/CommunityPrices">CommunityPrices</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunitiesResponse">CommunitiesResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>totalPages</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communities</td> <td> array[<a href="#/definitions/Community">Community</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityIcons</td> <td> array[<a href="#/definitions/CommunityIcon">CommunityIcon</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Community">Community</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>routeId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>about</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>shortName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>city</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>state</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>country</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>feed</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>pickupHubId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>dropoffHubId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>followers</td> <td> integer (int64) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>isFollowed</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityUrl</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startDate</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endDate</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityComment">CommunityComment</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>comment</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>commentPictureFileName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>commentPicture</td> <td> string </td> <td>optional</td> <td>-</td> <td>Base64 encoded</td> </tr> <tr> <td>userPictureFileName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>userPicture</td> <td> string </td> <td>optional</td> <td>-</td> <td>Base64 encoded</td> </tr> <tr> <td>userId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>userName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dateTime</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>numLikes</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>numDislikes</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>numComments</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityDetailsResponse">CommunityDetailsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>stats</td> <td> <a href="#/definitions/CommunityStats">CommunityStats</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>url</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>communityType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityPicture</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityFollowResponse">CommunityFollowResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>route</td> <td> <a href="#/definitions/UserRoute">UserRoute</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityIcon">CommunityIcon</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>communityType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityIcon</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityPrices">CommunityPrices</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>communityId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>communityShortName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>prevClose</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>lastPrice</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CommunityStats">CommunityStats</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>riders</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>rides</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>drivers</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>seats</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>followers</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>frequency</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>dayHigh</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>dayLow</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>yearHigh</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>yearLow</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>volume</td> <td> integer (int64) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/DriverInsurance">DriverInsurance</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>company</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>phoneNumber</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>policyId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>startDate</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td>2020-01-22T09:20</td> </tr> <tr> <td>endDate</td> <td> string (date) </td> <td>required</td> <td>-</td> <td>2020-01-22</td> </tr> </table> ## <a name="/definitions/DriverLicense">DriverLicense</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>number</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>state</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>expirationDate</td> <td> string (date) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/DriverSignupRequest">DriverSignupRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>vehicle</td> <td> <a href="#/definitions/DriverVehicle">DriverVehicle</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>insurance</td> <td> <a href="#/definitions/DriverInsurance">DriverInsurance</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>license</td> <td> <a href="#/definitions/DriverLicense">DriverLicense</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/DriverVehicle">DriverVehicle</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>make</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>model</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>year</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>color</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>vin</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>licensePlate</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>state</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>seatingCapacity</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ExchangeType">ExchangeType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>exchange</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>parentId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>subtypes</td> <td> array[string] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>smallIcon</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>mediumIcon</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>largeIcon</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ExchangeTypesResponse">ExchangeTypesResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>types</td> <td> array[<a href="#/definitions/ExchangeType">ExchangeType</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/FindOrdersRequest">FindOrdersRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>hubType</td> <td> string </td> <td>required</td> <td>-</td> <td>all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring</td> </tr> <tr> <td>tripDate</td> <td> string (date) </td> <td>required</td> <td>-</td> <td>2019-03-22</td> </tr> <tr> <td>startTime</td> <td> string </td> <td>required</td> <td>-</td> <td>HHmm</td> </tr> <tr> <td>maxOffsetMinutes</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>routes</td> <td> array[<a href="#/definitions/Route">Route</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>proximityMiles</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>maxHubPairs</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/FindOrdersResponse">FindOrdersResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>routes</td> <td> array[<a href="#/definitions/RouteHubs">RouteHubs</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/GetCommunitiesRequest">GetCommunitiesRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>location</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/GetCommunityCommentsResponse">GetCommunityCommentsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>comments</td> <td> array[<a href="#/definitions/CommunityComment">CommunityComment</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/GetHubsRequest">GetHubsRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>hubType</td> <td> string </td> <td>required</td> <td>-</td> <td>all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring</td> </tr> <tr> <td>location</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>radius</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/GetHubsResponse">GetHubsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>hubs</td> <td> array[<a href="#/definitions/Hub">Hub</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/HighestTradingRequest">HighestTradingRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>position</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>radius</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>hubType</td> <td> string </td> <td>required</td> <td>-</td> <td>all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring</td> </tr> </table> ## <a name="/definitions/HighestTradingResponse">HighestTradingResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>hub1</td> <td> array[<a href="#/definitions/Hub">Hub</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>hub2</td> <td> array[<a href="#/definitions/Hub">Hub</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractCount</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Hub">Hub</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>latitude</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>longitude</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>address</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>hubTypes</td> <td> array[string] </td> <td>required</td> <td>-</td> <td>all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring</td> </tr> </table> ## <a name="/definitions/HubOrderData">HubOrderData</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>hubType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>buyPrice</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>sellPrice</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/HubOrderDataResponse">HubOrderDataResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orderData</td> <td> array[<a href="#/definitions/HubOrderData">HubOrderData</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/HubPairOrders">HubPairOrders</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>startHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>distance</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>orders</td> <td> array[<a href="#/definitions/RouteOrder">RouteOrder</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LikeResponse">LikeResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>numLikes</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>numDislikes</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LocationUpdateRequest">LocationUpdateRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tripId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>position</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>speed</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>heading</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>accuracy</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>altitudeAccuracy</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LocationUpdateResponse">LocationUpdateResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>required</td> <td>-</td> <td>FUTURE, UPCOMING, AT_START, DELAYED, STARTED, ONGOING, PASSED_HALF_WAY, HALF_WAY, AFTER_MIDWAY, ARRIVED, COMPLETE, CANCELLED, EXPIRED</td> </tr> </table> ## <a name="/definitions/LoginRecoveryRequest">LoginRecoveryRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>credential</td> <td> string </td> <td>required</td> <td>-</td> <td>username, password</td> </tr> <tr> <td>email</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LoginRequest">LoginRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>username</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>password</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LoginResponse">LoginResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>auth_token</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>userId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>driverId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/OpenOrder">OpenOrder</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>orderDescription</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>tripDescription</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>timeZone</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/OrderDetails">OrderDetails</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tripDate</td> <td> string (date) </td> <td>required</td> <td>-</td> <td>2019-11-27</td> </tr> <tr> <td>tripTime</td> <td> string </td> <td>required</td> <td>-</td> <td>HHmm</td> </tr> <tr> <td>startHubId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHubId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/OrdersResponse">OrdersResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orders</td> <td> array[<a href="#/definitions/OpenOrder">OpenOrder</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PaypalCheckoutRequest">PaypalCheckoutRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>paymentMethodNonce</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>payerId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>orderId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>amount</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PaypalConfigurationResponse">PaypalConfigurationResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>env</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>clientId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>braintreeEnv</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PaypalPaymentRequest">PaypalPaymentRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>transactionId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>success</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>amount</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Picture">Picture</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>fileName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>picture</td> <td> string </td> <td>required</td> <td>-</td> <td>Base64 encoded</td> </tr> </table> ## <a name="/definitions/PictureResponse">PictureResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>fileName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>picture</td> <td> string </td> <td>required</td> <td>-</td> <td>Base64 encoded</td> </tr> </table> ## <a name="/definitions/PlaceOrderRequest">PlaceOrderRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>orderType</td> <td> string </td> <td>required</td> <td>-</td> <td>buy, sell</td> </tr> <tr> <td>price</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>quantity</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orderDetails</td> <td> <a href="#/definitions/OrderDetails">OrderDetails</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PlaceOrderResponse">PlaceOrderResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>contractId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>newOrderId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>orderTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractTradeStatsTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractMarketDepthTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Position2d">Position2d</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>lat</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>lon</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PostCommunityCommentRequest">PostCommunityCommentRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>communityId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>replyTo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>comment</td> <td> <a href="#/definitions/CommunityComment">CommunityComment</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ResponseWithId">ResponseWithId</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>Id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Route">Route</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>positions</td> <td> array[<a href="#/definitions/Position2d">Position2d</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/RouteHubs">RouteHubs</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>routeIndex</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>hubPairs</td> <td> array[<a href="#/definitions/HubPairOrders">HubPairOrders</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/RouteOrder">RouteOrder</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>orderId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>orderType</td> <td> string </td> <td>required</td> <td>-</td> <td>buy, sell</td> </tr> <tr> <td>price</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>quantity</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>tripDate</td> <td> string </td> <td>required</td> <td>-</td> <td>2019-11-27</td> </tr> <tr> <td>tripTime</td> <td> string </td> <td>required</td> <td>-</td> <td>HHmm</td> </tr> <tr> <td>orderTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractTradeStatsTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>contractMarketDepthTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/SignupRequest">SignupRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>username</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>password</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>firstname</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>lastname</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>email</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>phone</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>dob</td> <td> string (date) </td> <td>required</td> <td>-</td> <td>1990-03-22</td> </tr> <tr> <td>gender</td> <td> string </td> <td>required</td> <td>-</td> <td>male, female</td> </tr> <tr> <td>felony</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>sexOffender</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>address</td> <td> <a href="#/definitions/Address">Address</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>userProfilePicture</td> <td> <a href="#/definitions/UserProfilePicture">UserProfilePicture</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StopSeqOrder">StopSeqOrder</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>stopId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>stopOrder</td> <td> integer (int64) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StopsReorderRequest">StopsReorderRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>stops</td> <td> array[<a href="#/definitions/StopSeqOrder">StopSeqOrder</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StripePaymentRequest">StripePaymentRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>amount</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StripePaymentResponse">StripePaymentResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>paymentIntentId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>clientSecret</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>stripePublicKey</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StripePaymentVerifyRequest">StripePaymentVerifyRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>paymentIntentId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/StripePaymentVerifyResponse">StripePaymentVerifyResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>balance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>availableBalance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripInstance">TripInstance</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>startHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>driverId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>driverUserId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>driverName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>vehicleId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>passengerIds</td> <td> array[string] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>passengerNames</td> <td> array[string] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>distance</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>required</td> <td>-</td> <td>FUTURE, UPCOMING, AT_START, DELAYED, STARTED, ONGOING, PASSED_HALF_WAY, HALF_WAY, AFTER_MIDWAY, ARRIVED, COMPLETE, CANCELLED, EXPIRED</td> </tr> <tr> <td>startTime</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>tripTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>numStops</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>reviews</td> <td> array[<a href="#/definitions/TripReview">TripReview</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>communityName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>communityPicture</td> <td> <a href="#/definitions/Picture">Picture</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>meetingId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripMessage">TripMessage</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>messageId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>fromDriver</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>sender</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>senderName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>time</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>text</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripMessageRequest">TripMessageRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tripId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>isDriver</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>message</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripMessages">TripMessages</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>messages</td> <td> array[<a href="#/definitions/TripMessage">TripMessage</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripReview">TripReview</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>comment</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>user</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>rating</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripStop">TripStop</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tripId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>address</td> <td> <a href="#/definitions/Address">Address</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>lastName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>firstName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>email</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>phone</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>order</td> <td> integer (int64) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>position</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>packageId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>completionTime</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pictures</td> <td> array[string] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>review</td> <td> <a href="#/definitions/TripStopReview">TripStopReview</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripStopDetailsResponse">TripStopDetailsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>stop</td> <td> <a href="#/definitions/TripStop">TripStop</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripStopItem">TripStopItem</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>stopId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>address</td> <td> <a href="#/definitions/Address">Address</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>order</td> <td> integer (int64) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>location</td> <td> <a href="#/definitions/Position2d">Position2d</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>completionTime</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripStopReview">TripStopReview</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tripId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>stopId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>serviceQuality</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>cleanliness</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>routeComment</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>comment</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>rating</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripStopsResponse">TripStopsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>stops</td> <td> array[<a href="#/definitions/TripStopItem">TripStopItem</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TripsResponse">TripsResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>trips</td> <td> array[<a href="#/definitions/TripInstance">TripInstance</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/UpdateNotificationsRequest">UpdateNotificationsRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>routeId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>email</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>text</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/UserProfilePicture">UserProfilePicture</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>fileName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>base64data</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/UserRoute">UserRoute</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>time</td> <td> string </td> <td>required</td> <td>-</td> <td>HHmm</td> </tr> <tr> <td>description</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>startHub</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHub</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>emailNotification</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>textNotification</td> <td> boolean </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/UserRouteResponse">UserRouteResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>route</td> <td> <a href="#/definitions/UserRoute">UserRoute</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>startHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>endHub</td> <td> <a href="#/definitions/Hub">Hub</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/UserRoutesResponse">UserRoutesResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>routes</td> <td> array[<a href="#/definitions/UserRoute">UserRoute</a>] </td> <td>required</td> <td>-</td> <td>HHmm</td> </tr> </table> ## <a name="/definitions/WithdrawalRequest">WithdrawalRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>-</td> <td>zelle, paypal, check, trade, commission</td> </tr> <tr> <td>amount</td> <td> number (double) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>email</td> <td> string </td> <td>optional</td> <td>-</td> <td>For Paypal or Zelle withdrawals</td> </tr> <tr> <td>phoneNumber</td> <td> string </td> <td>optional</td> <td>-</td> <td>For Paypal or Zelle withdrawals</td> </tr> <tr> <td>deliveryMethod</td> <td> string </td> <td>optional</td> <td>-</td> <td>For check withdrawals: firstClass or overnight</td> </tr> </table> ## <a name="/definitions/WithdrawalResponse">WithdrawalResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>balance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>availableBalance</td> <td> number (double) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>confirmation</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ZoomMeetingDataResponse">ZoomMeetingDataResponse</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>result</td> <td> string </td> <td>required</td> <td>-</td> <td>ok, error</td> </tr> <tr> <td>errorDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>exceptionInfo</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>meetingTopic</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>meetingDuration</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>startUrl</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>joinUrl</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>password</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>h323_password</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>pstn_password</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table>