--- openapi: 3.0.1 info: title: API V1 version: v1 paths: "/api/v1/admin_users": get: summary: tags: - Admin Users security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer email: type: string name: type: string phone: type: string title: type: string observation: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/admin_users/{id}": get: summary: tags: - Admin Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer email: type: string name: type: string phone: type: string title: type: string observation: type: string created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/admin_users/create": post: summary: tags: - Admin Users security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer email: type: string name: type: string phone: type: string title: type: string observation: type: string created_at: type: string updated_at: type: string required: - id - email - name - phone - title - observation - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer email: type: string name: type: string phone: type: string title: type: string observation: type: string created_at: type: string updated_at: type: string required: - id - email - name - phone - title - observation - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: email: type: string name: type: string phone: type: string title: type: string observation: type: string poi_id: type: integer required: - current_password - password - password_confirmation "/api/v1/assets": post: summary: tags: - Assets security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string upload_url: type: string description: For "application/json" attached_file: type: string description: For "multipart/form-data" '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: attached_file: type: file description: For "multipart/form-data" file_name: type: string description: For "application/json" kind: type: string comment_id: type: integer description: For asset belongs to "Comment" message_id: type: integer description: For asset belongs to "Message" navigational_aid_id: type: integer description: For asset belongs to "NavigationalAid" poi_rating_id: type: integer description: For asset belongs to "PoiRating" post_id: type: integer description: For asset belongs to "Post" vessel_id: type: integer description: For asset belongs to "Vessel" hazard_id: type: integer description: For asset belongs to "Hazard" advice_pin_id: type: integer description: For asset belongs to "AdvicePin" map_issue_id: type: integer description: For asset belongs to "MapIssue" place_id: type: integer description: For asset belongs to "Place" police_pin_id: type: integer description: For asset belongs to "PolicePin" sealife_pin_id: type: integer description: For asset belongs to "SealifePin" weather_pin_id: type: integer description: For asset belongs to "WeatherPin" voyage_id: type: integer description: For asset belongs to "Voyage" poi_id: type: integer description: For asset belongs to "Poi" user_id: type: integer description: For asset belongs to "User" avatar_user_id: type: integer description: For asset belongs to "User" as "avatar_user" cover_user_id: type: integer description: For asset belongs to "User" as "cover_user" avatar_group_id: type: integer description: For asset belongs to "Group" as "avatar_group" cover_group_id: type: integer description: For asset belongs to "Group" as "cover_group" multipart/form-data: schema: type: object properties: attached_file: type: file description: For "multipart/form-data" file_name: type: string description: For "application/json" kind: type: string comment_id: type: integer description: For asset belongs to "Comment" message_id: type: integer description: For asset belongs to "Message" navigational_aid_id: type: integer description: For asset belongs to "NavigationalAid" poi_rating_id: type: integer description: For asset belongs to "PoiRating" post_id: type: integer description: For asset belongs to "Post" vessel_id: type: integer description: For asset belongs to "Vessel" hazard_id: type: integer description: For asset belongs to "Hazard" advice_pin_id: type: integer description: For asset belongs to "AdvicePin" map_issue_id: type: integer description: For asset belongs to "MapIssue" place_id: type: integer description: For asset belongs to "Place" police_pin_id: type: integer description: For asset belongs to "PolicePin" sealife_pin_id: type: integer description: For asset belongs to "SealifePin" weather_pin_id: type: integer description: For asset belongs to "WeatherPin" voyage_id: type: integer description: For asset belongs to "Voyage" poi_id: type: integer description: For asset belongs to "Poi" user_id: type: integer description: For asset belongs to "User" avatar_user_id: type: integer description: For asset belongs to "User" as "avatar_user" cover_user_id: type: integer description: For asset belongs to "User" as "cover_user" avatar_group_id: type: integer description: For asset belongs to "Group" as "avatar_group" cover_group_id: type: integer description: For asset belongs to "Group" as "cover_group" "/api/v1/assets/{id}": get: summary: tags: - Assets parameters: - name: id in: path required: true description: ID of entity schema: type: integer - name: size in: query description: Add a specific size (800x600) schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Assets security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string upload_url: type: string description: For "application/json" attached_file: type: string description: For "multipart/form-data" '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: attached_file: type: file description: For "multipart/form-data" file_name: type: string description: For "application/json" kind: type: string comment_id: type: integer description: For asset belongs to "Comment" message_id: type: integer description: For asset belongs to "Message" navigational_aid_id: type: integer description: For asset belongs to "NavigationalAid" poi_rating_id: type: integer description: For asset belongs to "PoiRating" post_id: type: integer description: For asset belongs to "Post" vessel_id: type: integer description: For asset belongs to "Vessel" hazard_id: type: integer description: For asset belongs to "Hazard" advice_pin_id: type: integer description: For asset belongs to "AdvicePin" map_issue_id: type: integer description: For asset belongs to "MapIssue" place_id: type: integer description: For asset belongs to "Place" police_pin_id: type: integer description: For asset belongs to "PolicePin" sealife_pin_id: type: integer description: For asset belongs to "SealifePin" weather_pin_id: type: integer description: For asset belongs to "WeatherPin" voyage_id: type: integer description: For asset belongs to "Voyage" poi_id: type: integer description: For asset belongs to "Poi" user_id: type: integer description: For asset belongs to "User" avatar_user_id: type: integer description: For asset belongs to "User" as "avatar_user" cover_user_id: type: integer description: For asset belongs to "User" as "cover_user" avatar_group_id: type: integer description: For asset belongs to "Group" as "avatar_group" cover_group_id: type: integer description: For asset belongs to "Group" as "cover_group" multipart/form-data: schema: type: object properties: attached_file: type: file description: For "multipart/form-data" file_name: type: string description: For "application/json" kind: type: string comment_id: type: integer description: For asset belongs to "Comment" message_id: type: integer description: For asset belongs to "Message" navigational_aid_id: type: integer description: For asset belongs to "NavigationalAid" poi_rating_id: type: integer description: For asset belongs to "PoiRating" post_id: type: integer description: For asset belongs to "Post" vessel_id: type: integer description: For asset belongs to "Vessel" hazard_id: type: integer description: For asset belongs to "Hazard" advice_pin_id: type: integer description: For asset belongs to "AdvicePin" map_issue_id: type: integer description: For asset belongs to "MapIssue" place_id: type: integer description: For asset belongs to "Place" police_pin_id: type: integer description: For asset belongs to "PolicePin" sealife_pin_id: type: integer description: For asset belongs to "SealifePin" weather_pin_id: type: integer description: For asset belongs to "WeatherPin" voyage_id: type: integer description: For asset belongs to "Voyage" poi_id: type: integer description: For asset belongs to "Poi" user_id: type: integer description: For asset belongs to "User" avatar_user_id: type: integer description: For asset belongs to "User" as "avatar_user" cover_user_id: type: integer description: For asset belongs to "User" as "cover_user" avatar_group_id: type: integer description: For asset belongs to "Group" as "avatar_group" cover_group_id: type: integer description: For asset belongs to "Group" as "cover_group" delete: summary: tags: - Assets security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/auth/sign_in": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: email: type: string password: type: string required: - email - password "/api/v1/auth/google/sign_in": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: auth_token: type: string email: type: string first_name: type: string last_name: type: string image: type: string uid: type: string required: - auth_token - email - first_name - last_name - image - uid "/api/v1/auth/apple/sign_in": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: fullName: type: string user: type: string identityToken: type: string required: - fullName - user - identityToken "/api/v1/auth/sign_up": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string password: type: string required: - first_name - last_name - email - password "/api/v1/auth/confirm": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: confirmation_token: type: string required: - confirmation_token "/api/v1/auth/send_confirmation": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: email: type: string required: - email "/api/v1/auth/reset_password": put: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: reset_password_token: type: string required: - reset_password_token "/api/v1/auth/send_reset_password": post: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string requestBody: content: application/json: schema: type: object properties: email: type: string required: - email "/api/v1/auth/get_reset_password": get: summary: tags: - Auth security: [] parameters: - name: user in: query schema: type: object properties: reset_password_token: type: string required: - reset_password_token responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string "/api/v1/auth/sign_out": delete: summary: tags: - Auth security: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: {} '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string "/api/v1/auth/password_change": put: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string required: - id - uid - first_name - kind - username - email - current_vessel_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string required: - id - uid - first_name - kind - username - email - current_vessel_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: current_password: type: string password: type: string password_confirmation: type: string required: - current_password - password - password_confirmation "/api/v1/auth": put: summary: tags: - Auth security: [] parameters: [] responses: '200': description: Respond ok headers: access-token: schema: type: string description: Access token for future requests client: schema: type: string description: Customer ID content: application/json: schema: type: object properties: data: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string follower_count: type: integer description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number speed: type: number direction: type: string search_lat: type: string search_lng: type: string current_vessel_id: type: integer has_soundings: type: boolean trusted: type: boolean suspicious: type: boolean apply_for_trial: type: boolean created_at: type: string updated_at: type: string active_at: type: string active: type: boolean '401': description: Respond not found content: application/json: schema: type: object properties: success: type: boolean type: type: string message: type: string '403': description: Respond forbidden. The body contains a field only an admin can change (email, password, privilege, user_subscription, kind, trusted, suspicious, blocked, provider, stripe_customer_id, payment and premium_free_user fields) under user. Nothing is updated. errors has one key per refused field. content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object additionalProperties: type: array items: type: string requestBody: content: application/json: schema: type: object properties: username: type: string first_name: type: string last_name: type: string description: type: string instagram_link: type: string web_link: type: string facebook_link: type: string tiktok_link: type: string youtube_link: type: string lat: type: string lng: type: string depth: type: number speed: type: number direction: type: number course: type: number platform_os: type: string avatar_asset_attributes: type: object properties: id: type: integer attached_file: type: string _destroy: type: boolean cover_asset_attributes: type: object properties: id: type: integer attached_file: type: string _destroy: type: boolean "/api/v1/banned_group_users": get: summary: tags: - Banned Group Users security: [] parameters: - name: user_id in: query description: Filter by User schema: type: integer - name: group_id in: query description: Filter by Group schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Banned Group Users security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: group_id: type: integer user_id: type: integer required: - group_id - user_id "/api/v1/banned_group_users/{id}": get: summary: tags: - Banned Group Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Banned Group Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/blocked_relationships": get: summary: tags: - Blocked Relationships security: [] parameters: - name: user_id in: query description: Filter by User schema: type: integer - name: blocked_user_id in: query description: Filter by BlockedUser schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer blocked_user_id: type: integer user_initiated: type: boolean created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Blocked Relationships security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer blocked_user_id: type: integer user_initiated: type: boolean created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer blocked_user_id: type: integer user_initiated: type: boolean created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: blocked_user_id: type: integer required: - blocked_user_id "/api/v1/blocked_relationships/{id}": get: summary: tags: - Blocked Relationships security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer blocked_user_id: type: integer user_initiated: type: boolean created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Blocked Relationships security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer blocked_user_id: type: integer user_initiated: type: boolean created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/data_exports": get: summary: tags: - Data Exports security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string multiple_files: type: boolean required: - id - user_id - type - kind - status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Data Exports security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string enum: - place - trips_report - trip kind: type: string status: type: string created_at: type: string updated_at: type: string multiple_files: type: boolean file_url: type: string file_urls: type: array items: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string enum: - place - trips_report - trip kind: type: string status: type: string created_at: type: string updated_at: type: string multiple_files: type: boolean file_url: type: string file_urls: type: array items: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: type: type: string enum: - place - trips_report - trip data_input: type: object required: - type application/form-data: schema: type: object properties: type: type: string enum: - place - trips_report - trip data_input: type: object required: - type "/api/v1/data_exports/{id}": get: summary: tags: - Data Exports security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string enum: - place - trips_report - trip kind: type: string status: type: string created_at: type: string updated_at: type: string multiple_files: type: boolean file_url: type: string file_urls: type: array items: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Data Exports security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string enum: - place - trips_report - trip kind: type: string status: type: string created_at: type: string updated_at: type: string multiple_files: type: boolean file_url: type: string file_urls: type: array items: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/data_imports": get: summary: tags: - Data Imports security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string required: - id - user_id - type - kind - status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Data Imports security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string data_output: type: object file_url: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string data_output: type: object file_url: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: type: type: string enum: - place attached_file: type: file required: - type - attached_file application/form-data: schema: type: object properties: type: type: string enum: - place attached_file: type: file required: - type - attached_file "/api/v1/data_imports/{id}": get: summary: tags: - Data Imports security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string data_output: type: object file_url: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Data Imports security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer type: type: string kind: type: string status: type: string created_at: type: string updated_at: type: string data_output: type: object file_url: type: string required: - id - user_id - type - kind - status - created_at - updated_at - file_url errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/depth_shadings": get: summary: tags: - Depth Shadings security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: user_id in: query description: Filter by User schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer extra: type: object properties: depth_shading_enabled: type: boolean shader_opacity: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Depth Shadings security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string current: type: boolean depth_shader_items_attributes: type: array items: type: object properties: color: type: string distance: type: string "/api/v1/depth_shadings/{id}": get: summary: tags: - Depth Shadings security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Depth Shadings security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string current: type: boolean clean_depth_shader_items: type: boolean description: To delete all depth_shader_items before save the new one depth_shader_items_attributes: type: array items: type: object properties: id: type: integer color: type: string distance: type: string _destroy: type: boolean delete: summary: tags: - Depth Shadings security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean default_flag: type: boolean preset_flag: type: boolean visible: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/follows": get: summary: tags: - Follows security: [] parameters: - name: followed_id in: query description: Filter by Followed schema: type: integer - name: follower_id in: query description: Filter by Follower schema: type: integer - name: kind in: query description: Filter by Kind schema: type: string enum: - ambassador - regular default: ambassador - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer followed_id: type: integer follower_id: type: integer kind: type: string enum: - ambassador - regular created_at: type: string updated_at: type: string followed: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string follower: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Follows security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer followed_id: type: integer follower_id: type: integer kind: type: string enum: - ambassador - regular created_at: type: string updated_at: type: string followed: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string follower: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer followed_id: type: integer follower_id: type: integer kind: type: string enum: - ambassador - regular created_at: type: string updated_at: type: string followed: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string follower: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: followed_id: type: integer kind: type: string enum: - ambassador - regular default: ambassador required: - followed_id "/api/v1/follows/{id}": get: summary: tags: - Follows security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer followed_id: type: integer follower_id: type: integer kind: type: string enum: - ambassador - regular created_at: type: string updated_at: type: string followed: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string follower: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Follows security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer followed_id: type: integer follower_id: type: integer kind: type: string enum: - ambassador - regular created_at: type: string updated_at: type: string followed: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string follower: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_invitations": get: summary: tags: - Group Invitations security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: status in: query description: Filter by Status schema: type: string enum: - requested - accepted - canceled - blocked - name: statuses in: query description: 'Filter by Status separated by coma Ex: ''requested,canceled''' schema: type: string enum: - requested - accepted - canceled - blocked - name: user_id in: query description: Filter by User schema: type: integer - name: group_id in: query description: Filter by Group schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Group Invitations security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: sender_id: type: integer group_id: type: integer user_id: type: integer required: - sender_id - group_id - user_id "/api/v1/group_invitations/{id}": get: summary: tags: - Group Invitations security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Group Invitations security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_invitations/{id}/approve": put: summary: tags: - Group Invitations security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_invitations/{id}/decline": put: summary: tags: - Group Invitations security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_invitations/{id}/block": put: summary: tags: - Group Invitations security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer sender_id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string sender: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_places": get: summary: tags: - Group Places security: [] parameters: - name: group_id in: query description: Filter by Group ID example: 42 schema: type: integer - name: place_id in: query description: Filter by Place ID example: 7 schema: type: integer - name: review_status in: query description: Filter by review status schema: type: string enum: - pending - accepted - rejected example: rejected - name: keyword in: query description: Filter by place name schema: type: string default: example: Restaurant - name: page in: query description: Actual page schema: type: integer default: 1 example: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 example: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean example: true responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Group Places security: [] parameters: [] responses: '201': description: Created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '422': description: Unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: group_id: type: integer example: 42 place_id: type: integer example: 7 required: - group_id - place_id required: true "/api/v1/group_places/{id}": parameters: - name: id in: path description: GroupPlace ID required: true example: 123 schema: type: integer get: summary: tags: - Group Places security: [] responses: '200': description: Found content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string delete: summary: tags: - Group Places security: [] responses: '200': description: Ok '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_places/{id}/accept": parameters: - name: id in: path description: GroupPlace ID required: true example: 123 schema: type: integer put: summary: tags: - Group Places security: [] responses: '200': description: Accepted content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_places/{id}/reject": parameters: - name: id in: path description: GroupPlace ID required: true example: 123 schema: type: integer put: summary: tags: - Group Places security: [] parameters: [] responses: '200': description: Rejected content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_report_pins": get: summary: tags: - Group Report Pins security: [] parameters: - name: group_id in: query description: Filter by Group ID example: 42 schema: type: integer - name: report_pin_id in: query description: Filter by ReportPin ID example: 7 schema: type: integer - name: review_status in: query description: Filter by review status schema: type: string enum: - pending - accepted - rejected example: rejected - name: keyword in: query description: Filter by report pin name schema: type: string default: example: Hazard - name: page in: query description: Actual page schema: type: integer default: 1 example: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 example: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean example: true responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Group Report Pins security: [] parameters: [] responses: '201': description: Created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at '422': description: Unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: group_id: type: integer example: 42 report_pin_id: type: integer example: 7 required: - group_id - report_pin_id required: true "/api/v1/group_report_pins/{id}": parameters: - name: id in: path description: GroupReportPin ID required: true example: 123 schema: type: integer get: summary: tags: - Group Report Pins security: [] responses: '200': description: Found content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string delete: summary: tags: - Group Report Pins security: [] responses: '200': description: Ok '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_report_pins/{id}/accept": parameters: - name: id in: path description: GroupReportPin ID required: true example: 123 schema: type: integer put: summary: tags: - Group Report Pins security: [] responses: '200': description: Accepted content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_report_pins/{id}/reject": parameters: - name: id in: path description: GroupReportPin ID required: true example: 123 schema: type: integer put: summary: tags: - Group Report Pins security: [] responses: '200': description: Rejected content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at '404': description: Not found content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/group_requests": get: summary: tags: - Group Requests security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: status in: query description: Filter by Status schema: type: string enum: - requested - accepted - canceled - blocked - name: statuses in: query description: 'Filter by Status separated by coma Ex: ''requested,canceled''' schema: type: string enum: - requested - accepted - canceled - blocked - name: user_id in: query description: Filter by User schema: type: integer - name: group_id in: query description: Filter by Group schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Group Requests security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: group_id: type: integer required: - group_id "/api/v1/group_requests/{id}": get: summary: tags: - Group Requests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Group Requests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_requests/{id}/approve": put: summary: tags: - Group Requests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_requests/{id}/decline": put: summary: tags: - Group Requests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/group_requests/{id}/block": put: summary: tags: - Group Requests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/groups": get: summary: tags: - Groups security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: exact_keyword in: query description: Define type of keyword search schema: type: boolean default: false - name: privacy in: query description: Filter by Privacy schema: type: string enum: - public - private - secret - archived - view_only - name: privacies in: query description: 'Filter by Privacies separated by coma Ex: ''public,private''' schema: type: string enum: - public - private - secret - archived - view_only - name: interest_ids in: query description: 'Filter by Interest Ids separated by coma Ex: ''21,23''' schema: type: string - name: user_id in: query description: Filter by User schema: type: integer - name: role in: query description: Filter by Role schema: type: string enum: - member - admin - not_member - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - role_admin_first - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - distance_asc - distance_desc - n_members_asc - n_members_desc - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: location in: query description: Filter by location schema: type: string enum: - anywhere - near_home_port - near_me - custom - name: lat in: query description: Filter by latitude schema: type: number default: 39.057193 - name: lng in: query description: Filter by longitude schema: type: number default: -76.831734 - name: distance in: query description: Filter by distance schema: type: number default: 100 - name: group_places in: query description: Include group places in response. Default is true on PUT/POST endpoints if either group_places_attributes or place_ids is set. Default is false otherwise. - name: group_places_preview_limit in: query description: Limit number of group_places in preview. Default is 10 - name: group_report_pins in: query description: Include group report pins in response. Default is true on PUT/POST endpoints if either group_report_pins_attributes or report_pin_ids is set. Default is false otherwise. - name: group_report_pins_preview_limit in: query description: Limit number of group_report_pins in preview. Default is 10 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Groups security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer poi_ids: type: array items: type: integer interest_ids: type: array items: type: integer invite_user_ids: type: array items: type: integer member_user_ids: type: array items: type: integer avatar_asset_attributes: type: object properties: attached_file: type: file cover_asset_attributes: type: object properties: attached_file: type: file group_places_attributes: type: array items: type: object properties: place_id: type: integer group_report_pins_attributes: type: array items: type: object properties: report_pin_id: type: integer place_ids: type: array items: type: integer report_pin_ids: type: array items: type: integer required: - name - privacy application/form-data: schema: type: object properties: name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer poi_ids: type: array items: type: integer interest_ids: type: array items: type: integer invite_user_ids: type: array items: type: integer member_user_ids: type: array items: type: integer avatar_asset_attributes: type: object properties: attached_file: type: file cover_asset_attributes: type: object properties: attached_file: type: file group_places_attributes: type: array items: type: object properties: place_id: type: integer group_report_pins_attributes: type: array items: type: object properties: report_pin_id: type: integer place_ids: type: array items: type: integer report_pin_ids: type: array items: type: integer required: - name - privacy "/api/v1/groups/{id}": get: summary: tags: - Groups security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Groups security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer poi_ids: type: array items: type: integer interest_ids: type: array items: type: integer invite_user_ids: type: array items: type: integer member_user_ids: type: array items: type: integer avatar_asset_attributes: type: object properties: attached_file: type: file cover_asset_attributes: type: object properties: attached_file: type: file group_places_attributes: type: array items: type: object properties: place_id: type: integer group_report_pins_attributes: type: array items: type: object properties: report_pin_id: type: integer place_ids: type: array items: type: integer report_pin_ids: type: array items: type: integer required: - name - privacy application/form-data: schema: type: object properties: name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer poi_ids: type: array items: type: integer interest_ids: type: array items: type: integer invite_user_ids: type: array items: type: integer member_user_ids: type: array items: type: integer avatar_asset_attributes: type: object properties: attached_file: type: file cover_asset_attributes: type: object properties: attached_file: type: file group_places_attributes: type: array items: type: object properties: place_id: type: integer group_report_pins_attributes: type: array items: type: object properties: report_pin_id: type: integer place_ids: type: array items: type: integer report_pin_ids: type: array items: type: integer required: - name - privacy delete: summary: tags: - Groups security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer interest_ids: type: array items: type: integer poi_ids: type: array items: type: integer group_places_preview: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string place: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: [] required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status required: - id - group_id - place_id - review_status - created_at - updated_at group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/groups/exist": get: summary: tags: - Groups security: [] parameters: - name: name in: query required: true description: Name of group schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: exists: type: boolean "/api/v1/group_users": get: summary: tags: - Group Users security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: role in: query description: Filter by Role schema: type: string enum: - member - admin - name: push_notifications in: query description: Filter by Push Notifications setting schema: type: string enum: - 'off' - posts - all - name: user_id in: query description: Filter by User schema: type: integer - name: group_id in: query description: Filter by Group schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Group Users security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: role: type: string user_id: type: integer group_id: type: integer push_notifications: type: string enum: - 'off' - posts - all required: - role - user_id - group_id "/api/v1/group_users/{id}": get: summary: tags: - Group Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Group Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: role: type: string user_id: type: integer group_id: type: integer push_notifications: type: string enum: - 'off' - posts - all required: - role - user_id - group_id delete: summary: tags: - Group Users security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/interests": get: summary: tags: - Interests parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: category in: query description: Filter by Category schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Interests security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string category: type: string translations: type: object required: - name - category "/api/v1/interests/{id}": get: summary: tags: - Interests parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Interests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string category: type: string translations: type: object required: - name - category delete: summary: tags: - Interests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string category: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/list_categories": get: summary: tags: - List Categories security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - pos_asc - pos_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - List Categories security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string pos: type: integer required: - name application/form-data: schema: type: object properties: name: type: string pos: type: integer required: - name "/api/v1/list_categories/batch": post: summary: tags: - List Categories security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: array items: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: object properties: name: type: string pos: type: integer required: - name application/form-data: schema: type: array items: type: object properties: name: type: string pos: type: integer required: - name delete: summary: tags: - List Categories security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer application/form-data: schema: type: array items: type: integer "/api/v1/list_categories/{id}": get: summary: tags: - List Categories security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - List Categories security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string pos: type: integer required: - name application/form-data: schema: type: object properties: name: type: string pos: type: integer required: - name delete: summary: tags: - List Categories security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string user_id: type: integer pos: type: integer created_at: type: string updated_at: type: string required: - id - name - user_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/lists": get: summary: tags: - Lists security: [] parameters: - name: label in: query description: Filter by Label schema: type: string enum: - bookmark - favorite - offline - show_on_map - custom - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: entity_type in: query description: Filter by entity_type schema: type: string enum: - Place - Poi - Voyage - Trip - name: entity_types in: query description: 'Filter by entity_types separated by coma Ex: ''Poi,Place''' schema: type: string enum: - Place - Poi - Voyage - Trip - name: entity_id in: query description: Filter by entity_id schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer label: type: string list_category_id: type: integer user_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer created_at: type: string updated_at: type: string entity: type: object required: - id - label - user_id - entity_type - entity_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Lists security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer label: type: string list_category_id: type: integer user_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer created_at: type: string updated_at: type: string entity: type: object required: - id - label - user_id - entity_type - entity_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer label: type: string list_category_id: type: integer user_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer created_at: type: string updated_at: type: string entity: type: object required: - id - label - user_id - entity_type - entity_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: label: type: string list_category_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer required: - label - list_category_id - entity_type - entity_id "/api/v1/lists/{id}": get: summary: tags: - Lists security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer label: type: string list_category_id: type: integer user_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer created_at: type: string updated_at: type: string entity: type: object required: - id - label - user_id - entity_type - entity_id - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string delete: summary: tags: - Lists security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer label: type: string list_category_id: type: integer user_id: type: integer duplicate_entity: type: boolean entity_type: type: string entity_id: type: integer created_at: type: string updated_at: type: string entity: type: object required: - id - label - user_id - entity_type - entity_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/lists/{entity_type}/{entity_id}/toggle_favorite": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string - name: entity_id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/lists/{entity_type}/{entity_id}/toggle_bookmark": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string - name: entity_id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/lists/{entity_type}/{entity_id}/toggle_offline": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string - name: entity_id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/lists/{entity_type}/{entity_id}/toggle_show_on_map": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string - name: entity_id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string "/api/v1/lists/{entity_type}/{entity_id}/toggle_custom": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string - name: entity_id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string requestBody: content: application/json: schema: type: object properties: list_category_id: type: integer required: - list_category_id "/api/v1/lists/{entity_type}/batch_toggle_favorite": post: summary: tags: - Lists security: [] parameters: - name: entity_type in: path required: true description: Type of entity schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer "/api/v1/map_users": get: summary: tags: - Map Users parameters: - name: sw_latitude in: query required: true description: Latitude of the southwest corner of the map schema: type: number example: 38.9 - name: sw_longitude in: query required: true description: Longitude of the southwest corner of the map schema: type: number example: -77.05 - name: ne_latitude in: query required: true description: Latitude of the northeast corner of the map schema: type: number example: 39.2 - name: ne_longitude in: query required: true description: Longitude of the northeast corner of the map schema: type: number example: -76.6 - name: active in: query description: If true, return currently active users; if false, return recently active users schema: type: boolean default: false - name: kind in: query description: Filter by user kind schema: type: string enum: - normal - ambassador - name: friends in: query description: |- Filter by friendship with the current user. If true, only friends are returned; if false, only non-friends; if omitted, returns both. schema: type: boolean - name: group_ids in: query description: Filter by Group IDs schema: type: array items: type: integer - name: poi_ids in: query description: Filter by Affiliated POI IDs schema: type: array items: type: integer - name: exclude_watching in: query description: Exclude currently watched users from result. schema: type: boolean - name: only_on_water in: query description: If true, only show users that are on water. If false, show users regardless of whether they are on water. schema: type: boolean default: true - name: page_total in: query description: Items per page schema: type: integer default: 20 minimum: 1 maximum: 100 responses: '200': description: Respond ok content: application/json: schema: type: object description: 'NOTE: The following properties will be null unless the watched user is a friend or the watched user''s map_visibility is set to public: [first_name, last_name, image, email]' properties: status: type: string example: ok data: type: object properties: items: type: array items: type: object properties: id: type: integer first_name: type: string last_name: type: string image: type: string description: Avatar URL lat: type: number description: Last known latitude lng: type: number description: Last known longitude active: type: boolean description: Whether the user is currently active friendship_status: type: string description: Relationship with current user enum: - none - requested - pending - friends groups_in_common: type: integer description: Number of group IDs shared with the current user affiliated_poi_in_common: type: array description: POI IDs shared with the current user items: type: integer map_visibility: type: string description: Visibility on the map as per user settings enum: - public - friends_only - private '422': description: Respond unprocessable entity (validation error) content: application/json: schema: type: object properties: status: type: string example: error message: type: string example: Validation failed "/api/v1/navigational_aids": get: summary: tags: - Navigational Aids parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - name: source in: query description: Filter by source schema: type: string enum: - USACE - NOAA - CHS - SML - NY - LNMC - LM - LS - USCG - USCG-Navcen - Argo User - Lake Winnipesaukee Campaign - name: kind in: query description: Filter by kind schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''buoy,beacon''' schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: user_id in: query description: Filter by User schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Navigational Aids security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck subkind: type: string enum: - other - cardinal - lateral - special_purpose_general - safe_water - insolated_danger - unknown - junction lat: type: string lng: type: string source: type: string objname: type: string objname_short: type: string inform: type: string created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" required: - name - lat - lng - kind "/api/v1/navigational_aids/{id}": get: summary: tags: - Navigational Aids parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Navigational Aids security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck subkind: type: string enum: - other - cardinal - lateral - special_purpose_general - safe_water - insolated_danger - unknown - junction lat: type: string lng: type: string source: type: string objname: type: string objname_short: type: string inform: type: string created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" required: - name - lat - lng - kind delete: summary: tags: - Navigational Aids security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subkind: type: string source: type: string objname: type: string objname_short: type: string inform: type: string user_id: type: integer created_at: type: string updated_at: type: string shape: type: string description: Only for "buoy" or "beacon" color: type: string description: Only for "buoy" or "beacon" color_short: type: string description: Only for "buoy" or "beacon" colpat: type: string description: Only for "buoy" or "beacon" conrad: type: string description: Only for "buoy" or "beacon" catlam: type: string description: Only for "buoy" or "beacon" catspm: type: string description: Only for "buoy" or "beacon" light_color: type: string description: Only for "buoy" or "beacon" light_exclit: type: string description: Only for "buoy" or "beacon" light_litchr: type: string description: Only for "buoy" or "beacon" light_sigper: type: string description: Only for "buoy" or "beacon" light_info: type: string description: Only for "buoy" or "beacon" icon: type: string description: Only for "buoy" or "beacon" catrea: type: string description: Only for "restricted_area" restrn: type: string description: Only for "restricted_area" mile: type: string description: Only for "mile_marker" valsou: type: string description: Only for "wreck" or "obstruction" or "rock" watlev: type: string description: Only for "wreck" status: type: string description: Only for "wreck" or "obstruction" or "rock" natsur: type: string description: Only for "obstruction" or "rock" catobs: type: string description: Only for "obstruction" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/notifications": get: summary: tags: - Notifications security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - created_at_asc - created_at_desc - name: notification_types in: query description: "Filter by notification_types separated by coma Ex: 'GroupInvitation,Message\t'" schema: type: string - name: user_id in: query description: Filter by User schema: type: integer - name: read in: query description: Filter by read schema: type: boolean - name: visible in: query description: Filter by visible schema: type: boolean responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer total_items: type: integer total_items_in_page: type: integer items: type: array items: type: object properties: id: type: integer read: type: boolean message: type: string title: type: string priority: type: string created_at: type: string updated_at: type: string user_id: type: integer notification_type: type: string notifiable_type: type: string notifiable_id: type: integer sender_id: type: integer notifiable: type: object sender: type: object '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/notifications/{id}": get: summary: tags: - Notifications security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer read: type: boolean message: type: string title: type: string priority: type: string created_at: type: string updated_at: type: string user_id: type: integer notification_type: type: string notifiable_type: type: string notifiable_id: type: integer sender_id: type: integer notifiable: type: object sender: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Notifications security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer read: type: boolean message: type: string title: type: string priority: type: string created_at: type: string updated_at: type: string user_id: type: integer notification_type: type: string notifiable_type: type: string notifiable_id: type: integer sender_id: type: integer notifiable: type: object sender: type: object '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer read: type: boolean message: type: string title: type: string priority: type: string created_at: type: string updated_at: type: string user_id: type: integer notification_type: type: string notifiable_type: type: string notifiable_id: type: integer sender_id: type: integer notifiable: type: object sender: type: object errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: read: type: string application/form-data: schema: type: object properties: read: type: string delete: summary: tags: - Notifications security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer read: type: boolean message: type: string title: type: string priority: type: string created_at: type: string updated_at: type: string user_id: type: integer notification_type: type: string notifiable_type: type: string notifiable_id: type: integer sender_id: type: integer notifiable: type: object sender: type: object errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/optimized_lists/pois/upsert": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: map_visibility in: query description: Filter by map visibility schema: type: boolean - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string poi_type: type: string partner: type: string info: type: object properties: key: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/pois/removed": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: map_visibility in: query description: Filter by map visibility schema: type: boolean - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string poi_type: type: string partner: type: string info: type: object properties: key: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/navigational_aids/upsert": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: source in: query description: Filter by source schema: type: string enum: - USACE - NOAA - CHS - SML - NY - LNMC - LM - LS - USCG - USCG-Navcen - Argo User - Lake Winnipesaukee Campaign - name: kind in: query description: Filter by kind schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''buoy,beacon''' schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string title: type: string main_info: type: string kind: type: string subkind: type: string icon: type: string info: type: object properties: key: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/navigational_aids/removed": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: source in: query description: Filter by source schema: type: string enum: - USACE - NOAA - CHS - SML - NY - LNMC - LM - LS - USCG - USCG-Navcen - Argo User - Lake Winnipesaukee Campaign - name: kind in: query description: Filter by kind schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''buoy,beacon''' schema: type: string enum: - other - buoy - beacon - restricted_area - mile_marker - light - sound - wind_turbine - wreck - obstruction - rock - non_dangerous_wreck - dangerous_wreck - exposed_wreck - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string title: type: string main_info: type: string kind: type: string subkind: type: string icon: type: string info: type: object properties: key: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/places/upsert": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: place_type in: query description: Filter by place_type schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: group_places in: query description: Include group places in response responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string place_type: type: string status: type: string submit: type: boolean user_id: type: integer description: type: string group_places: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/places/removed": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: place_type in: query description: Filter by place_type schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: group_places in: query description: Include group places in response responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string place_type: type: string status: type: string submit: type: boolean user_id: type: integer description: type: string group_places: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/report_pins/upsert": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: kind in: query description: Filter by kind schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''buoy,beacon''' schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string info: type: object properties: key: type: string user_id: type: integer description: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/report_pins/removed": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: kind in: query description: Filter by kind schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''buoy,beacon''' schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string info: type: object properties: key: type: string user_id: type: integer description: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/quick_pins/upsert": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string user_id: type: integer '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/optimized_lists/quick_pins/removed": get: summary: tags: - Optimized Lists parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: paginate in: query description: Activate pagination schema: type: boolean default: true - name: only_ids in: query description: Only show ids schema: type: boolean default: false - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer latitude: type: number longitude: type: number name: type: string user_id: type: integer '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/places": get: summary: tags: - Places parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: place_type in: query description: Filter by place_type schema: type: string enum: - Anchorage - Artificial Reef - Beach - Boat Club - BoatRamp - Bridge - Business - City/Town - Club/Association - Dam - Dock - Dock Bar/Restaurant - Fishing Spot - Fuel - Fuel Dock - Hotel - Inlet - Light House - Kayak Launch - Lock - Marina - Mooring - Mooring for Rent (Private) - Other - Point of Interest - Restaurant/Bar - Yacht Club - Dive Spot - Dive Site - Snorkeling - RV Park/Campground - Park - Race Mark - Museum - Raft-up - my_location - gps_location - address - home_port - name: submit in: query description: Filter by submit schema: type: boolean - name: status in: query description: Filter by status schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: group_places in: query description: Include group places in response. Default is true on PUT/POST endpoints if either group_places_attributes or group_ids is set. Default is false otherwise. responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Places security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string rating: type: number review: type: string group_places_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - place_type - lat - lng application/form-data: schema: type: object properties: name: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string rating: type: number review: type: string group_places_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - place_type - lat - lng "/api/v1/places/export": get: summary: tags: - Places security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/places/export_send": post: summary: tags: - Places security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/places/import": post: summary: tags: - Places security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: file: type: file required: - file application/form-data: schema: type: object properties: file: type: file required: - file "/api/v1/places/{id}": get: summary: tags: - Places parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Places security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string rating: type: number review: type: string group_places_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - place_type - lat - lng application/form-data: schema: type: object properties: name: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string rating: type: number review: type: string group_places_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - place_type - lat - lng delete: summary: tags: - Places security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/places/{id}/duplicate": post: summary: tags: - Places security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string sub_type: type: string place_type: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number submit: type: boolean phone: type: string website: type: string email: type: string bookmark: type: boolean bookmark_date: type: string user_id: type: integer depth: type: string timestamp: type: string status: type: string feedback: type: string poi_id: type: integer favorite: type: boolean rating: type: number review: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at group_places: type: array items: type: object properties: id: type: integer group_id: type: integer place_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - group_id - report_pin_id - review_status - created_at - updated_at required: - id - name - privacy - created_at - updated_at required: - id - group_id - place_id - review_status - created_at - updated_at required: - id - name - place_type - lat - lng - user_id - created_at - updated_at - status errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/places/batch": delete: summary: tags: - Places security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer application/form-data: schema: type: array items: type: integer "/api/v1/poi_ratings": get: summary: tags: - Poi Ratings parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - rating_asc - rating_desc - poi_name_asc - poi_name_desc - name: rating in: query description: Filter by rating schema: type: integer - name: user_id in: query description: Filter by User schema: type: integer - name: poi_id in: query description: Filter by Poi schema: type: integer - name: poi_name in: query description: Filter by Poi Name schema: type: string - name: reply in: query description: Filter by with replies schema: type: boolean - name: photos in: query description: Filter by with photos schema: type: boolean responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Poi Ratings security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer rating: type: integer review: type: string required: - poi_id - rating "/api/v1/poi_ratings/{id}": get: summary: tags: - Poi Ratings parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Poi Ratings security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer rating: type: integer review: type: string required: - poi_id - rating delete: summary: tags: - Poi Ratings security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer rating: type: integer review: type: string reply: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer own_rating: type: boolean asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" date_deployed: type: string description: Only for "artificial_reef" depth: type: string description: Only for "artificial_reef" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/pois": get: summary: tags: - Pois parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - name: poi_type in: query description: Filter by poi_type schema: type: string enum: - Anchorage - Artificial Reef - Bar - Basin - Bay - Beach - Bend - Boat Club - BoatRamp - Bridge - Business - Canal - Cape - Channel - City/Town - Cliff - Club/Association - Cove - Creek - Crossing - Dam - Dive Site - Dock Bar/Restaurant - Dock (Free) - Dock (Pay) - Dock for Rent (Private) - Falls - Fishing Spot - Free Dock - Fuel - Fuel Dock - Glacier - Gut - Hotel - Inlet - Isthmus - Island - Lake - Levee - Kayak Launch - Light House - Lock - Marina - Military - Mooring - Mooring for Rent (Private) - Museum - Other - Park - Point of Interest - Private Dock - Race Mark - Raft-up - Rapids - Reef - Reservoir - Restaurant/Bar - RV Park/Campground - Sea - Snorkeling - Spring - Stream - Swamp - Towing - Yacht Club - name: sub_type in: query description: Filter by sub_type schema: type: string - name: dockshare in: query description: Filter linked with dockshare schema: type: boolean - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/pois/export": get: summary: tags: - Pois security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/pois/export_send": post: summary: tags: - Pois security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/pois/{id}": get: summary: tags: - Pois parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string poi_ratings: type: array items: type: object properties: id: type: integer rating: type: integer review: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Pois security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string poi_ratings: type: array items: type: object properties: id: type: integer rating: type: integer review: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string poi_ratings: type: array items: type: object properties: id: type: integer rating: type: integer review: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string lat: type: string lng: type: string poi_type: type: string enum: - Anchorage - Artificial Reef - Bar - Basin - Bay - Beach - Bend - Boat Club - BoatRamp - Bridge - Business - Canal - Cape - Channel - City/Town - Cliff - Club/Association - Cove - Creek - Crossing - Dam - Dive Site - Dock Bar/Restaurant - Dock (Free) - Dock (Pay) - Dock for Rent (Private) - Falls - Fishing Spot - Free Dock - Fuel - Fuel Dock - Glacier - Gut - Hotel - Inlet - Isthmus - Island - Lake - Levee - Kayak Launch - Light House - Lock - Marina - Military - Mooring - Mooring for Rent (Private) - Museum - Other - Park - Point of Interest - Private Dock - Race Mark - Raft-up - Rapids - Reef - Reservoir - Restaurant/Bar - RV Park/Campground - Sea - Snorkeling - Spring - Stream - Swamp - Towing - Yacht Club sub_type: type: string category: type: string subcategory: type: string dock_type: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string event_url: type: string email: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string fuel_visible: type: boolean transients_visible: type: boolean approach_visible: type: boolean amenities_visible: type: boolean fuel_available: type: boolean transients_available: type: boolean amenities_available: type: boolean map_visibility: type: boolean tidal_change: type: string current: type: string tide_and_extra: type: string transient_available: type: boolean moorings_available: type: boolean transient_price: type: string transient_price_night: type: string length_max: type: string beam_max: type: string amp_30: type: boolean amp_50: type: boolean amp_100: type: boolean other_transient_info: type: string gas_octane_87_value: type: string gas_octane_89_value: type: string gas_octane_93_value: type: string gas_octane_94_plus_value: type: string diesel_value: type: string gas_octane_87: type: boolean gas_octane_89: type: boolean gas_octane_93: type: boolean gas_octane_94_plus: type: boolean diesel: type: boolean gas: type: boolean gas_non_ethanol: type: boolean supplies: type: boolean supplies_info: type: string cable_satellite: type: boolean cable_satellite_info: type: string captains_lounge: type: boolean captains_lounge_info: type: string fitness_center: type: boolean fitness_center_info: type: string floating_docks: type: boolean floating_docks_info: type: string grocery: type: boolean grocery_info: type: string haul_out_capabilities: type: boolean haul_out_capabilities_info: type: string ice: type: boolean ice_info: type: string laundry: type: boolean laundry_info: type: string repair_capabilities: type: boolean repair_capabilities_info: type: string pets_welcome: type: boolean other_pet_info: type: string picnic_area: type: boolean picnic_area_info: type: string playground: type: boolean playground_info: type: string pump_out: type: boolean pump_out_info: type: string restaurant: type: boolean restaurant_info: type: string bathrooms: type: boolean bathrooms_info: type: string security: type: boolean security_info: type: string showers: type: boolean showers_info: type: string pool: type: boolean pool_info: type: string transportation: type: boolean other_transportation_info: type: string trash: type: boolean trash_info: type: string wifi: type: boolean wifi_info: type: string required: - name - lat - lng delete: summary: tags: - Pois security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string poi_ratings: type: array items: type: object properties: id: type: integer rating: type: integer review: type: string created_at: type: string updated_at: type: string user_id: type: integer poi_id: type: integer asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/poi_vessels": get: summary: tags: - POI Vessels security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - latest_used_at_asc - latest_used_at_desc - name: poi_id in: query description: Filter by POI schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - POI Vessels security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port_name: type: string required: - poi_id - name - boat_type - draft - buffer "/api/v1/poi_vessels/{id}": get: summary: tags: - POI Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - POI Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port_name: type: string required: - poi_id - name - boat_type - draft - buffer delete: summary: tags: - POI Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/poi_vessels/{id}/copy": post: summary: tags: - POI Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number poi_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/posts": get: summary: tags: - Posts security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: post_kind in: query description: Filter by Kind schema: type: string enum: - standard - global - ambassador - group - name: post_kinds in: query description: 'Filter by kinds separated by coma Ex: ''standard,group,global,ambassador''' schema: type: string enum: - standard - global - ambassador - group - name: user_id in: query description: Filter by User schema: type: integer - name: group_id in: query description: Filter by Group schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: entity_type in: query description: Filter by entity_type schema: type: string enum: - Voyage - Place - Poi - ReportPin - Vessel - Trip - name: entity_id in: query description: Filter by entity_id schema: type: integer - name: ambassador_ids in: query description: 'Filter by ambassador IDs separated by comma Ex: ''1,2,3''' schema: type: string - name: friend_ids in: query description: 'Filter by friend IDs separated by comma Ex: ''1,2,3''' schema: type: string - name: group_ids in: query description: 'Filter by group IDs separated by comma Ex: ''1,2,3''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Posts security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: kind: type: string message: type: string lat: type: string lng: type: string group_id: type: integer entity_type: type: string entity_id: type: integer assets_attributes: type: array items: type: object properties: attached_file: type: file required: - kind application/form-data: schema: type: object properties: kind: type: string message: type: string lat: type: string lng: type: string group_id: type: integer entity_type: type: string entity_id: type: integer assets_attributes: type: array items: type: object properties: attached_file: type: file required: - kind "/api/v1/posts/{id}": get: summary: tags: - Posts security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Posts security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer main_post_id: type: integer group_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: kind: type: string message: type: string lat: type: string lng: type: string group_id: type: integer entity_type: type: string entity_id: type: integer assets_attributes: type: array items: type: object properties: attached_file: type: file required: - kind application/form-data: schema: type: object properties: kind: type: string message: type: string lat: type: string lng: type: string group_id: type: integer entity_type: type: string entity_id: type: integer assets_attributes: type: array items: type: object properties: attached_file: type: file required: - kind delete: summary: tags: - Posts security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string message: type: string lat: type: string lng: type: string user_id: type: integer group_id: type: integer main_post_id: type: integer entity_type: type: string entity_id: type: integer shared_count: type: integer likes_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/posts/{id}/duplicate": post: summary: Duplicate a post as own (feed and/or groups) tags: - Posts security: [] parameters: - name: id in: path required: true description: ID of post to duplicate schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string data: oneOf: - type: object - type: array items: type: object '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: group_ids: type: array items: type: integer description: Group IDs to duplicate into (one post per group). Empty array creates no group posts. my_feed: type: boolean description: If true, also duplicate as a normal feed post. Combine with group_ids to target groups and feed in one request. If both params are omitted, defaults to feed only (backward compatible). "/api/v1/quick_pins": get: summary: tags: - Quick Pins parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Quick Pins security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string required: - lat - lng "/api/v1/quick_pins/{id}": get: summary: tags: - Quick Pins parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Quick Pins security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string lat: type: string lng: type: string required: - lat - lng delete: summary: tags: - Quick Pins security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string latitude: type: string longitude: type: string user_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/quick_pins/batch": delete: summary: tags: - Quick Pins security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer "/api/v1/report_pins": get: summary: tags: - Report Pins parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: kind in: query description: Filter by kind schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''sos,no_wake_zone''' schema: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding - name: subtype in: query description: Filter by subtype schema: type: string - name: user_id in: query description: Filter by User schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: from_date in: query description: 'Filter from date Ex: 2024-05-01 08:00:00' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Report Pins security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string group_report_pins: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string group_report_pins: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding subtype: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number description: Required for "depth_sounding" speed: type: string description: Only for "no_wake_zone" voyage_id: type: integer group_report_pins_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - lat - lng - kind application/form-data: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding subtype: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number description: Required for "depth_sounding" speed: type: string description: Only for "no_wake_zone" voyage_id: type: integer group_report_pins_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - lat - lng - kind "/api/v1/report_pins/export": get: summary: tags: - Report Pins security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/report_pins/export_send": post: summary: tags: - Report Pins security: [] parameters: - name: ids in: query required: true description: 'Ids separated by coma Ex: ''123,124,125''' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/report_pins/{id}": get: summary: tags: - Report Pins parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Report Pins security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string group_report_pins: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string group_report_pins: type: array items: type: object properties: id: type: integer group_id: type: integer report_pin_id: type: integer review_status: type: string enum: pending: 0 accepted: 1 rejected: 2 creator_id: type: integer nullable: true created_at: type: string updated_at: type: string group_name: type: string group: type: object properties: id: type: integer name: type: string description: type: string website: type: string privacy: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number group_location_type: type: string enum: - Place - Poi group_location_id: type: integer group_location: type: object country: type: string state: type: string city: type: string address: type: string avatar_asset_id: type: integer avatar_asset_link: type: string cover_asset_id: type: integer cover_asset_link: type: string group_users_count: type: integer created_at: type: string updated_at: type: string distance: type: number own_group_user: type: object properties: id: type: integer user_id: type: integer group_id: type: integer role: type: string notifications_active: type: boolean push_notifications: type: string enum: - 'off' - posts - all updates_count: type: integer created_at: type: string updated_at: type: string own_group_request: type: object properties: id: type: integer user_id: type: integer group_id: type: integer status: type: string created_at: type: string updated_at: type: string admin_user_ids: type: array items: type: integer group_places_preview: type: array items: [] group_report_pins_preview: type: array items: [] required: - id - name - privacy - created_at - updated_at required: - id - group_id - report_pin_id - review_status - created_at - updated_at report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding subtype: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number description: Required for "depth_sounding" speed: type: string description: Only for "no_wake_zone" voyage_id: type: integer group_report_pins_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - lat - lng - kind application/form-data: schema: type: object properties: name: type: string description: type: string kind: type: string enum: - no_wake_zone - sos - police - local_advice - weather - hazard - map_issue - marine_life - suggested_nav_aid - depth_sounding subtype: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number description: Required for "depth_sounding" speed: type: string description: Only for "no_wake_zone" voyage_id: type: integer group_report_pins_attributes: type: array items: type: object properties: group_id: type: integer group_ids: type: array items: type: integer required: - name - lat - lng - kind delete: summary: tags: - Report Pins security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string latitude: type: number longitude: type: number depth: type: number kind: type: string subtype: type: string user_id: type: integer voyage_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_report_pin_vote: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string report_pin_votes: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/report_pins/batch": delete: summary: tags: - Report Pins security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer application/form-data: schema: type: array items: type: integer "/api/v1/report_pin_votes": get: summary: tags: - Report Pin Votes parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: vote_type in: query description: Filter by vote_type schema: type: string enum: - vote_type_down - vote_type_up - name: user_id in: query description: Filter by User schema: type: integer - name: report_pin_id in: query description: Filter by ReportPin schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Report Pin Votes security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: report_pin_id: type: integer vote_type: type: string enum: - vote_type_down - vote_type_up required: - report_pin_id - vote_type "/api/v1/report_pin_votes/{id}": get: summary: tags: - Report Pin Votes parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Report Pin Votes security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: report_pin_id: type: integer vote_type: type: string enum: - vote_type_down - vote_type_up required: - report_pin_id - vote_type delete: summary: tags: - Report Pin Votes security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer report_pin_id: type: integer vote_type: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string report_pin: type: object properties: id: type: integer name: type: string description: type: string lat: type: string lng: type: string kind: type: string subtype: type: string user_id: type: integer pin_votes_down_count: type: integer pin_votes_up_count: type: integer user_comments_count: type: integer created_at: type: string updated_at: type: string speed: type: string description: Only for "no_wake_zone" errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{trip_id}/route_segments/{id}": get: summary: tags: - Route Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of route segment schema: type: integer - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Route Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of route segment schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: string description: Binary data (application/octet-stream) application/octet-stream: schema: type: string description: Binary data (application/octet-stream) '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string application/octet-stream: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string application/octet-stream: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: waypoints: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number name: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic required: - kind - lat - lng delete: summary: tags: - Route Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of route segment schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{trip_id}/route_segments": post: summary: tags: - Route Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: string description: Binary data (application/octet-stream) application/octet-stream: schema: type: string description: Binary data (application/octet-stream) '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string application/octet-stream: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: waypoints: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number name: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic required: - kind - lat - lng "/api/v1/trips/{trip_id}/route_segments/{id}/binary": get: summary: tags: - Route Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of route segment schema: type: integer responses: '200': description: Respond ok content: application/octet-stream: schema: type: string description: Binary data (application/octet-stream) '404': description: Respond not found content: application/octet-stream: schema: type: object properties: message: type: string status: type: string "/api/v1/search": get: summary: tags: - Search parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - keyword_asc - keyword_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: grouped in: query description: Group results by type schema: type: boolean default: true - name: on_users in: query description: Filter users schema: type: boolean default: true - name: on_groups in: query description: Filter groups schema: type: boolean default: true responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: type: type: string id: type: integer keyword: type: string created_at: type: string updated_at: type: string users: type: array optional: true items: type: object properties: type: type: string id: type: integer keyword: type: string created_at: type: string updated_at: type: string groups: type: array optional: true items: type: object properties: type: type: string id: type: integer keyword: type: string created_at: type: string updated_at: type: string "/api/v1/search_users": get: summary: tags: - Search Users parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - first_name_asc - first_name_desc - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - distance_asc - distance_desc - follower_count_asc - follower_count_desc - name: user_kind in: query description: Filter by user_kind schema: type: string enum: - normal - ambassador - name: kind in: query description: Filter by kind schema: type: string enum: - all - friends - non_friends - name: poi_ids in: query description: 'Filter by POIs id separated by coma Ex: ''1,2,3''' schema: type: string - name: group_ids in: query description: 'Filter by Groups id separated by coma Ex: ''1,2,3''' schema: type: string - name: source in: query description: Source, can be 'map' or 'list' schema: type: string - name: location in: query description: Filter by location schema: type: string enum: - anywhere - near_home_port - near_me - custom - name: vessel_type in: query description: Filter by vessel_type schema: type: string - name: recent in: query description: Filter by recent updated schema: type: boolean - name: active in: query description: Filter by active updated schema: type: boolean - name: moving in: query description: Filter by moving updated schema: type: boolean - name: lat in: query description: Filter by latitude schema: type: number default: 39.057193 - name: lng in: query description: Filter by longitude schema: type: number default: -76.831734 - name: distance in: query description: Filter by distance schema: type: number default: 100 - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 - name: on_water in: query description: Filter if user is or not on water schema: type: boolean - name: followed_by_me in: query description: Filter by users followed by me schema: type: boolean responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer total_friends: type: integer total_non_friends: type: integer items: type: array items: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string depth: type: string speed: type: string direction: type: string search_lat: type: string search_lng: type: string current_vessel_id: type: integer has_soundings: type: boolean created_at: type: string updated_at: type: string followed_by_me: type: boolean friendship_status: type: string mutual_friends: type: integer friend_request_id: type: integer mutual_affiliations: type: integer affiliated_poi_in_common: type: integer groups_in_common: type: integer distance: type: number distance_against_current_user: type: number current_vessel: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string user_setting: type: object properties: id: type: integer user_id: type: integer created_at: type: string updated_at: type: string visibility: type: integer user_profile_visibility: type: integer map_visibility: type: integer newsfeed_content_visability: type: integer captains_log_visability: type: integer sent_friend_request: type: boolean accepted_friend_request: type: boolean like_pins: type: boolean like_posts: type: boolean comment_pins: type: boolean comment_posts: type: boolean comment_like: type: boolean shared_places: type: boolean shared_voyages: type: boolean group_invite: type: boolean group_accept: type: boolean all_messages: type: boolean push_notification_ahoys: type: boolean toast_notification_ahoys: type: boolean pause_notifications: type: boolean direct_messages: type: boolean message_requests: type: boolean share_destination_eta: type: boolean user_option: type: object properties: id: type: integer user_id: type: integer current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string ambassador_location_privacy: type: string initial_lat: type: string initial_lng: type: string initial_address: type: string depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string favorites: type: array items: type: string created_at: type: string updated_at: type: string followed_ambassador: type: boolean user_tracks: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string date: type: string user_id: type: integer '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/search_users/{id}": get: summary: tags: - Search Users parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string depth: type: string speed: type: string direction: type: string search_lat: type: string search_lng: type: string current_vessel_id: type: integer has_soundings: type: boolean created_at: type: string updated_at: type: string friendship_status: type: string mutual_friends: type: integer friend_request_id: type: integer mutual_affiliations: type: integer affiliated_poi_in_common: type: integer groups_in_common: type: integer followed_by_me: type: boolean distance: type: number distance_against_current_user: type: number current_vessel: type: object properties: id: type: integer name: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer created_at: type: string updated_at: type: string lat: type: string lng: type: string height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string user_setting: type: object properties: id: type: integer user_id: type: integer created_at: type: string updated_at: type: string visibility: type: integer user_profile_visibility: type: integer map_visibility: type: integer newsfeed_content_visability: type: integer captains_log_visability: type: integer sent_friend_request: type: boolean accepted_friend_request: type: boolean like_pins: type: boolean like_posts: type: boolean comment_pins: type: boolean comment_posts: type: boolean comment_like: type: boolean shared_places: type: boolean shared_voyages: type: boolean group_invite: type: boolean group_accept: type: boolean all_messages: type: boolean push_notification_ahoys: type: boolean toast_notification_ahoys: type: boolean pause_notifications: type: boolean direct_messages: type: boolean message_requests: type: boolean share_destination_eta: type: boolean user_option: type: object properties: id: type: integer user_id: type: integer current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string ambassador_location_privacy: type: string initial_lat: type: string initial_lng: type: string initial_address: type: string depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string favorites: type: array items: type: string created_at: type: string updated_at: type: string followed_ambassador: type: boolean user_tracks: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string date: type: string user_id: type: integer '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/selected_voyages": get: summary: tags: - Selected Voyages security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: voyage_id in: query description: Filter by Voyage schema: type: integer - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Selected Voyages security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: voyage_id: type: integer required: - voyage_id "/api/v1/selected_voyages/{id}": get: summary: tags: - Selected Voyages security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Selected Voyages security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: voyage_id: type: integer required: - voyage_id delete: summary: tags: - Selected Voyages security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer voyage_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/tide_currents": get: summary: tags: - Tides/Currents parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: measure_datetimetime in: query description: 'Filter by datetime (ex: "05/14/2024 07:41")' schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - sync_at_asc - sync_at_desc - name: kind in: query description: Filter by kind schema: type: string enum: - tide - current - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer source: type: string kind: type: string uid: type: string name: type: string lat: type: string lng: type: string direction: type: string speed: type: string depth: type: string tide_status: type: string measure_datetime: type: string prediction_sync_at: type: string prediction_start_date: type: string prediction_end_date: type: string prediction_data: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/tide_currents/nearby": get: summary: Up to 3 closest reachable stations within 50 miles of the given point, ordered by routing distance tags: - Tides/Currents parameters: - name: lat in: query required: true description: Latitude of the origin schema: type: number - name: lng in: query required: true description: Longitude of the origin schema: type: number - name: kind in: query description: Filter by kind. It narrows the stations that are looked at, so asking for one kind still answers up to 3 of it schema: type: string enum: - tide - current - name: measure_datetime in: query description: 'Datetime of the measure (ex: "05/14/2024 07:41")' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: items: type: array items: type: object properties: id: type: integer source: type: string kind: type: string uid: type: string name: type: string lat: type: string lng: type: string direction: type: string speed: type: string depth: type: string tide_status: type: string measure_datetime: type: string distance: type: number description: Straight line distance in miles routing_distance: type: number description: Distance in miles along the route created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/tide_currents/{id}": get: summary: tags: - Tides/Currents parameters: - name: id in: path required: true description: ID of entity schema: type: integer - name: measure_datetimetime in: query description: 'Filter by datetime (ex: "05/14/2024 07:41")' schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer kind: type: string source: type: string uid: type: string name: type: string lat: type: string lng: type: string direction: type: string speed: type: string depth: type: string tide_status: type: string measure_datetime: type: string prediction_sync_at: type: string prediction_start_date: type: string prediction_end_date: type: string prediction_data: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: object items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{trip_id}/track_segments/{id}": get: summary: tags: - Track Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of track segment schema: type: integer - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Track Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of track segment schema: type: integer - name: save_async in: query required: false description: Process the track segment in the background. Defaults to false. schema: type: boolean responses: '200': description: Track segment saved or accepted for background processing content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng application/octet-stream: schema: type: object properties: tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng delete: summary: tags: - Track Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of track segment schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{trip_id}/track_segments": post: summary: tags: - Track Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: save_async in: query required: false description: Process the track segment in the background. Defaults to false. schema: type: boolean responses: '200': description: Track segment saved or accepted for background processing content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer trip_id: type: integer status: type: string enum: - pending - generated - error coords_count: type: integer distance: type: number created_at: type: string updated_at: type: string tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - trip_id - coords_count - distance - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng application/octet-stream: schema: type: object properties: tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng "/api/v1/trips/{trip_id}/track_segments/{id}/binary": get: summary: tags: - Track Segments security: [] parameters: - name: trip_id in: path required: true description: ID of trip schema: type: integer - name: id in: path required: true description: ID of track segment schema: type: integer responses: '200': description: Respond ok content: application/octet-stream: schema: type: string description: Binary data (application/octet-stream) '404': description: Respond not found content: application/octet-stream: schema: type: object properties: message: type: string status: type: string "/api/v1/trips": get: summary: tags: - Trips security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - start_date_asc - start_date_desc - created_at_asc - created_at_desc - start_location_asc - start_location_desc - end_location_asc - end_location_desc - name: user_id in: query description: Filter by User schema: type: integer - name: external_id in: query description: Filter by External ID schema: type: string - name: list_category_id in: query description: Filter by List Category ID schema: type: string - name: ownership in: query description: Filter by ownership schema: type: string enum: - all - my_trips - friends_trips - name: favorite in: query description: Filter by favorite schema: type: boolean - name: offline in: query description: Filter by offline schema: type: boolean - name: show_on_map in: query description: Filter by show_on_map schema: type: boolean - name: planned_coords in: query description: Add planned_coords in response schema: type: boolean - name: tracked_coords in: query description: Add tracked_coords in response schema: type: boolean - name: routing in: query description: Filter by routing schema: type: string enum: - manual - automatic - name: origin in: query description: Filter by origin schema: type: string enum: - mm - cl - gpx - sounding - name: reported in: query description: Filter by reported schema: type: boolean - name: kind in: query description: Filter by kind schema: type: string enum: - voyage - route - track - log - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''voyage,route''' schema: type: string enum: - voyage - route - track - log - name: publication_status in: query description: Filter by publication_status schema: type: string enum: - draft - published - name: processing_status in: query description: Filter by processing_status schema: type: string enum: - pending - generating - done - error - name: navigation_status in: query description: Filter by navigation_status schema: type: string enum: - planning - ongoing - paused - finished - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long - name: updated_from in: query description: Filter by updated from given datetime schema: type: string - name: updated_to in: query description: Filter by updated to given datetime schema: type: string responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Trips security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log publication_status: type: string enum: - draft - published navigation_status: type: string enum: - planning - ongoing - paused - finished name: type: string description: type: string start_date: type: string end_date: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string reported: type: boolean save_mode: type: string enum: - async - sync - draft optimized: type: boolean default: true optimization_value: type: string default: '0.00001' binary_mode: type: boolean waypoints: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number name: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic required: - kind - lat - lng tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - name - kind "/api/v1/trips/{id}": get: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log publication_status: type: string enum: - draft - published navigation_status: type: string enum: - planning - ongoing - paused - finished name: type: string description: type: string start_date: type: string end_date: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string reported: type: boolean save_mode: type: string enum: - async - sync - draft optimized: type: boolean default: true optimization_value: type: string default: '0.00001' binary_mode: type: boolean waypoints: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number name: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic required: - kind - lat - lng tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number latitude: type: number longitude: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - name - kind delete: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/add": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/remove": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/import": post: summary: tags: - Trips security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string file: type: file required: - file multipart/form-data: schema: type: object properties: name: type: string description: type: string file: type: file required: - file "/api/v1/trips/report": get: summary: tags: - Trips security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - start_date_asc - start_date_desc - created_at_asc - created_at_desc - start_location_asc - start_location_desc - end_location_asc - end_location_desc - name: user_id in: query description: Filter by User schema: type: integer - name: ownership in: query description: Filter by ownership schema: type: string enum: - all - my_trips - friends_trips - name: favorite in: query description: Filter by favorite schema: type: boolean - name: offline in: query description: Filter by offline schema: type: boolean - name: show_on_map in: query description: Filter by show_on_map schema: type: boolean - name: planned_coords in: query description: Add planned_coords in response schema: type: boolean - name: tracked_coords in: query description: Add tracked_coords in response schema: type: boolean - name: routing in: query description: Filter by routing schema: type: string enum: - manual - automatic - name: origin in: query description: Filter by origin schema: type: string enum: - mm - cl - gpx - sounding - name: kind in: query description: Filter by kind schema: type: string enum: - voyage - route - track - log - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''voyage,route''' schema: type: string enum: - voyage - route - track - log - name: publication_status in: query description: Filter by publication_status schema: type: string enum: - draft - published - name: processing_status in: query description: Filter by processing_status schema: type: string enum: - pending - generating - done - error - name: navigation_status in: query description: Filter by navigation_status schema: type: string enum: - planning - ongoing - paused - finished - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/send_report_email": get: summary: tags: - Trips security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - id_asc - id_desc - name_asc - name_desc - updated_at_asc - updated_at_desc - start_date_asc - start_date_desc - created_at_asc - created_at_desc - start_location_asc - start_location_desc - end_location_asc - end_location_desc - name: user_id in: query description: Filter by User schema: type: integer - name: ownership in: query description: Filter by ownership schema: type: string enum: - all - my_trips - friends_trips - name: favorite in: query description: Filter by favorite schema: type: boolean - name: offline in: query description: Filter by offline schema: type: boolean - name: show_on_map in: query description: Filter by show_on_map schema: type: boolean - name: planned_coords in: query description: Add planned_coords in response schema: type: boolean - name: tracked_coords in: query description: Add tracked_coords in response schema: type: boolean - name: routing in: query description: Filter by routing schema: type: string enum: - manual - automatic - name: origin in: query description: Filter by origin schema: type: string enum: - mm - cl - gpx - sounding - name: kind in: query description: Filter by kind schema: type: string enum: - voyage - route - track - log - name: kinds in: query description: 'Filter by kinds separated by coma Ex: ''voyage,route''' schema: type: string enum: - voyage - route - track - log - name: publication_status in: query description: Filter by publication_status schema: type: string enum: - draft - published - name: processing_status in: query description: Filter by processing_status schema: type: string enum: - pending - generating - done - error - name: navigation_status in: query description: Filter by navigation_status schema: type: string enum: - planning - ongoing - paused - finished - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/export": get: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer - name: mode in: query description: 'What to export: the track, the route, or the route simplified to 250 points. Defaults to the track for voyages and tracks, and to the route for routes and logs' schema: type: string enum: - tracked - planned - planned_fixed_points responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/export_send": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer - name: mode in: query description: 'What to export: the track, the route, or the route simplified to 250 points. Defaults to the track for voyages and tracks, and to the route for routes and logs' schema: type: string enum: - tracked - planned - planned_fixed_points responses: '200': description: Respond ok content: application/json: schema: type: object '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/confirm_update": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/cancel_update": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at "/api/v1/trips/{id}/take_voyage": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer - name: copy_source in: query description: Select source point to copy schema: type: string enum: - tracked_coords - planned_coords - name: vessel_id in: query description: ID of vessel schema: type: integer - name: reverse in: query description: Reverse coords schema: type: boolean default: false responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/duplicate": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/{id}/refresh_vessel_trip": post: summary: tags: - Trips security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer old_voyage_id: type: integer user_id: type: integer external_id: type: string kind: type: string enum: - voyage - route - track - log uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string start_location: type: string end_location: type: string draft_depth: type: number buffer_depth: type: number bridge_vert: type: number bridge_horiz: type: number avoid_ocean: type: boolean avoid_inland: type: boolean disable_smoothing: type: boolean prioritycostfactor: type: number hug_shore: type: boolean access: type: string publication_status: type: string enum: - draft - published processing_status: type: string enum: - pending - generating - done - error navigation_status: type: string enum: - planning - ongoing - paused - finished planned_coords_count: type: integer planned_distance: type: number tracked_coords_count: type: integer tracked_distance: type: number vessel_id: type: integer origin: type: string enum: - mm - cl - gpx - sounding average_speed: type: number fuel_consumption: type: number fuel_type: type: string planned_est_duration: type: string planned_est_fuel: type: number height: type: number boat_name: type: string manufacturer_model: type: string optimized: type: boolean default: true optimization_value: type: string default: '0.00001' sounding_name: type: string sounding_slices: type: string sounding_mac: type: string reported: type: boolean created_at: type: string updated_at: type: string binary_mode: type: boolean has_draft: type: boolean list_bookmark: type: boolean default: false list_favorite: type: boolean default: false list_offline: type: boolean default: false list_show_on_map: type: boolean default: false asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at waypoints: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing route_segment_ids: type: array items: type: integer track_segment_ids: type: array items: type: integer planned_coords: type: array items: type: object properties: lat: type: number lng: type: number depth: type: number name: type: string address: type: string referable_type: type: string enum: - Place - Poi - ReportPin referable_id: type: integer referable_kind: type: string kind: type: string enum: - start_point - end_point - waypoint - innerpoint - track routing: type: string enum: - manual - generated - automatic automatic_status: type: string enum: - complete - fail automatic_message: type: string required: - kind - lat - lng - routing tracked_coords: type: array items: type: object properties: lat: type: number lng: type: number accuracy: type: number depth: type: number timestamp: type: string required: - lat - lng required: - id - uid - name - kind - publication_status - processing_status - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/trips/batch": delete: summary: tags: - Trips security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: array items: type: integer application/form-data: schema: type: array items: type: integer "/api/v1/user_checklists": get: summary: tags: - User Checklists security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: user_id in: query description: Filter by User schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Checklists security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string user_checklist_items_attributes: type: array items: type: object properties: description: type: string check: type: boolean "/api/v1/user_checklists/{id}": get: summary: tags: - User Checklists security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Checklists security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string user_checklist_items_attributes: type: array items: type: object properties: description: type: string check: type: boolean delete: summary: tags: - User Checklists security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer name: type: string user_checklist_items_count: type: integer created_at: type: string updated_at: type: string user_checklist_items: type: array items: type: object properties: description: type: string check: type: boolean pos: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_comments": get: summary: tags: - User Comments security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: commentable_type in: query description: Filter by commentable_type schema: type: string enum: - ReportPin - Post - Place - name: commentable_id in: query description: Filter by commentable_id schema: type: integer - name: user_id in: query description: Filter by User schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Comments security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: message: type: string commentable_type: type: string enum: - ReportPin - Post - Place commentable_id: type: integer required: - message - commentable_type - commentable_id "/api/v1/user_comments/{id}": get: summary: tags: - User Comments security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Comments security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: message: type: string commentable_type: type: string enum: - ReportPin - Post - Place commentable_id: type: integer required: - message - commentable_type - commentable_id delete: summary: tags: - User Comments security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer message: type: string user_id: type: integer likes_count: type: integer commentable_type: type: string commentable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string own_user_like: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user_likes: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_interests": get: summary: tags: - User Interests security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: interest_id in: query description: Filter by Interest schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Interests security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: interest_id: type: integer required: - interest_id "/api/v1/user_interests/{id}": get: summary: tags: - User Interests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Interests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: interest_id: type: integer required: - interest_id delete: summary: tags: - User Interests security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer interest_id: type: integer created_at: type: string updated_at: type: string interest: type: object properties: id: type: integer name: type: string translated_name: type: string category: type: string translated_category: type: string created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_likes": get: summary: tags: - User Likes security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - name: likeable_type in: query description: Filter by likeable_type schema: type: string enum: - UserComment - Post - name: likeable_id in: query description: Filter by likeable_id schema: type: integer - name: user_id in: query description: Filter by User schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Likes security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: likeable_type: type: string enum: - UserComment - Post likeable_id: type: integer required: - likeable_type - likeable_id "/api/v1/user_likes/{id}": get: summary: tags: - User Likes security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Likes security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: likeable_type: type: string enum: - UserComment - Post likeable_id: type: integer required: - likeable_type - likeable_id delete: summary: tags: - User Likes security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer likeable_type: type: string likeable_id: type: integer post_id: type: integer created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string description: type: string follower_count: type: integer facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string avatar_asset_id: type: integer image: type: string cover_asset_id: type: integer cover: type: string email: type: string lat: type: string lng: type: string current_vessel_id: type: integer created_at: type: string updated_at: type: string errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_location": put: summary: tags: - User Location security: [] description: Accepts one location or an array of locations. A single broadcast is sent after all locations are processed. parameters: [] responses: '200': description: Respond ok '422': description: Respond unprocessable entity '404': description: Respond not found requestBody: content: application/json: schema: oneOf: - type: object properties: lat: type: number lng: type: number depth: type: number speed: type: number direction: type: number heading: type: number course: type: number accuracy: type: number location_timestamp: type: integer required: - lat - lng - type: array items: type: object properties: lat: type: number lng: type: number depth: type: number speed: type: number direction: type: number heading: type: number course: type: number accuracy: type: number location_timestamp: type: integer required: - lat - lng "/api/v1/user_options": get: summary: tags: - User Options security: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string hug_shore: type: boolean ambassador_location_privacy: type: string initial_lat: type: string initial_lng: type: string initial_address: type: string initial_location_type: type: string enum: - Place - Poi initial_location_id: type: integer depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string track_color: type: string depth_shading_contour_lines_enabled: type: boolean visible_only_on_water: type: boolean cursor_beam_color: type: string route_color: type: string map_3d_mode: type: string enum: - manual - auto - never auto_course_up: type: boolean auto_heading_line: type: boolean auto_recenter: type: boolean font_size: type: string font_color: type: string depth_label_density: type: integer initial_location: type: object favorites: type: array items: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at current_depth_shading: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string current_vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at required: - id - user_id - created_at - route_settings - ambassador_location_privacy - shader_opacity - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Options security: [] parameters: [] responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string hug_shore: type: boolean ambassador_location_privacy: type: string initial_lat: type: string initial_lng: type: string initial_address: type: string initial_location_type: type: string enum: - Place - Poi initial_location_id: type: integer depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string track_color: type: string depth_shading_contour_lines_enabled: type: boolean visible_only_on_water: type: boolean cursor_beam_color: type: string route_color: type: string map_3d_mode: type: string enum: - manual - auto - never auto_course_up: type: boolean auto_heading_line: type: boolean auto_recenter: type: boolean font_size: type: string font_color: type: string depth_label_density: type: integer initial_location: type: object favorites: type: array items: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at current_depth_shading: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string current_vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at required: - id - user_id - created_at - route_settings - ambassador_location_privacy - shader_opacity - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string hug_shore: type: boolean ambassador_location_privacy: type: string initial_lat: type: string initial_lng: type: string initial_address: type: string initial_location_type: type: string enum: - Place - Poi initial_location_id: type: integer depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string track_color: type: string depth_shading_contour_lines_enabled: type: boolean visible_only_on_water: type: boolean cursor_beam_color: type: string route_color: type: string map_3d_mode: type: string enum: - manual - auto - never auto_course_up: type: boolean auto_heading_line: type: boolean auto_recenter: type: boolean font_size: type: string font_color: type: string depth_label_density: type: integer initial_location: type: object favorites: type: array items: type: string created_at: type: string updated_at: type: string user: type: object properties: id: type: integer uid: type: string first_name: type: string last_name: type: string kind: type: string privilege: type: string description: type: string facebook_link: type: string instagram_link: type: string youtube_link: type: string tiktok_link: type: string web_link: type: string username: type: string image: type: string cover: type: string user_subscription: type: string lifetime_member: type: boolean email: type: string lat: type: string lng: type: string current_vessel_id: type: integer trusted: type: boolean suspicious: type: boolean created_at: type: string updated_at: type: string required: - id - uid - first_name - last_name - kind - privilege - username - email - user_subscription - created_at - updated_at current_depth_shading: type: object properties: id: type: integer user_id: type: integer name: type: string current: type: boolean created_at: type: string updated_at: type: string depth_shader_items: type: array items: type: object properties: id: type: integer color: type: string distance: type: string created_at: type: string updated_at: type: string current_vessel: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at required: - id - user_id - created_at - route_settings - ambassador_location_privacy - shader_opacity - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: current_depth_shading_id: type: integer current_vessel_id: type: integer route_settings: type: string enum: - default - avoid - outside hug_shore: type: boolean ambassador_location_privacy: type: string enum: - current_location - homeport - water_location_24_hours_ago - water_location_1_week_ago initial_lat: type: string initial_lng: type: string initial_address: type: string initial_location_type: type: string enum: - Place - Poi initial_location_id: type: integer depth_shading_enabled: type: boolean shader_opacity: type: string speed_unit: type: string distance_unit: type: string wind_speed_unit: type: string offline_mode: type: string stay_in_channels: type: boolean length_unit: type: string volume_unit: type: string temperature_unit: type: string coordinate_format: type: string track_color: type: string depth_shading_contour_lines_enabled: type: boolean visible_only_on_water: type: boolean cursor_beam_color: type: string route_color: type: string map_3d_mode: type: string enum: - manual - auto - never auto_course_up: type: boolean auto_heading_line: type: boolean auto_recenter: type: boolean font_size: type: string font_color: type: string depth_label_density: type: integer favorites: type: array items: type: string required: - route_settings - ambassador_location_privacy - shader_opacity "/api/v1/user_push_tokens": post: summary: tags: - User Surveys security: [] parameters: [] responses: '201': description: Respond created '422': description: Respond unprocessable entity requestBody: content: application/json: schema: type: object properties: client: type: string expo_token: type: string fcm_token: type: string apn_token: type: string "/api/v1/user_search_histories": get: summary: tags: - User Search Histories parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - created_at_asc - created_at_desc - name: poi_id in: query description: Filter by Poi schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Search Histories security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer required: - poi_id "/api/v1/user_search_histories/{id}": get: summary: tags: - User Search Histories parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Search Histories security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: poi_id: type: integer required: - poi_id delete: summary: tags: - User Search Histories security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer user_id: type: integer poi_id: type: integer created_at: type: string updated_at: type: string poi: type: object properties: id: type: integer name: type: string lat: type: string lng: type: string poi_type: type: string sub_type: type: string category: type: string subcategory: type: string additional_types: type: string address: type: string mile: type: string number_of_slips: type: string description: type: string phone: type: string website: type: string email: type: string event_url: type: string clean_marina: type: boolean rental_boats: type: boolean boaters_can_update_poi_vessels: type: boolean poi_sponsor: type: string uid: type: string hashuid: type: string map_visibility: type: boolean complete_perc: type: string poi_ratings_overall: type: string poi_ratings_count: type: string created_at: type: string updated_at: type: string claimed: type: boolean fuel_visible: type: string transients_visible: type: string approach_visible: type: string amenities_visible: type: string fuel_available: type: string transients_available: type: string amenities_available: type: string operation: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" vhf_channel: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" operation_hour: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" after_hours_contact: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_87_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_89_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_93_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_octane_94_plus_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" diesel_value: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" gas_non_ethanol: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" valv_tect: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_discounts: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_gas_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" boaters_can_update_prices: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" last_fuel_change_by: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" credit_cards: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" checks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" payment_discount: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tidal_change: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" current: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" tide_and_extra: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" approach: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fuel_dock: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_depth_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" moorings_available: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_night_updated_at: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transient_price_night: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" length_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" beam_max: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_30: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_50: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" amp_100: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transient_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" snag_a_slip_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_id: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_rezi_url: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" call_dockmaster: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockwa: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_id: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" dockshare_url: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_reservation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_size_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" supplies_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" cable_satellite_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" captains_lounge_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" fitness_center_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" floating_docks_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" grocery_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" haul_out_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" ice_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" laundry_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" repair_capabilities_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pets_welcome: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_pet_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" picnic_area_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" playground_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pump_out_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" restaurant_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" bathrooms_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" security_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" showers_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" pool_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" transportation: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" other_transportation_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" trash_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi: type: boolean description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" wifi_info: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" date_deployed: type: string description: Only for "artificial_reef" depth: type: number description: In feet. Only for "artificial_reef" ver_clr: type: number description: In feet. Only for "bridge" hor_clr: type: number description: In feet. Only for "bridge" open_ver_clr: type: number description: In feet. Only for "bridge" open_hor_clr: type: number description: In feet. Only for "bridge" bridge_type: type: string description: Only for "bridge" bridge_schedule: type: string description: Only for "bridge" bridge_other_info: type: string description: Only for "bridge" number_of_chamber: type: string description: Only for "lock" lock_size: type: string description: Only for "lock" lock_schedule: type: string description: Only for "lock" lock_other_info: type: string description: Only for "lock" slip_mooring_diagram_asset_link: type: string description: Only for "yacht_club" or "marina" or "dock_bar_restaurant" or "type_dock" or "club_association" slip_mooring_diagram_asset: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string asset_links: type: array items: type: string assets: type: array items: type: object properties: id: type: integer folder_name: type: string file_name: type: string url: type: string required: - id - user_id - poi_id - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_subscriptions": get: summary: tags: - User Subscriptions security: [] parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - updated_at_asc - updated_at_desc - created_at_asc - created_at_desc - name: status in: query description: Filter by status schema: type: string - name: activated in: query description: Filter by Activated schema: type: boolean - name: platform in: query description: Filter by Platform schema: type: string enum: - stripe - revcat - name: store in: query description: Filter by Store schema: type: string enum: - app_store - play_store - web - name: membership_name in: query description: Filter by MembershipName schema: type: string enum: - Argo Premium (Lifetime) - Argo Premium (Yearly) - Argo Premium (Monthly) - Canada charts (Yearly) - Canada charts (Monthly) responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: {} '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Subscriptions security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: {} '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: {} errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: email: type: string checkout_mode: type: string enum: - subscription - payment default: subscription platform: type: string enum: - stripe - revcat name: type: string enum: - 1_year_of_argo_premium - 1_month_of_argo_premium - 1_month_of_argo_canada_charts:yearly - 1_month_of_argo_canada_charts:monthly - lifetime_of_argo_premium "/api/v1/user_subscriptions/{id}": get: summary: tags: - User Subscriptions security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: {} '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_subscriptions/{id}/cancel": delete: summary: tags: - User Subscriptions security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: {} errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_subscriptions/{id}/sync": post: summary: tags: - User Subscriptions security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: {} errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/user_surveys": get: summary: tags: - User Surveys parameters: - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - created_at_asc - created_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: value in: query description: Filter by value schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - User Surveys security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: value: type: string feedback: type: string origin: type: string required: - value "/api/v1/user_surveys/{id}": get: summary: tags: - User Surveys parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - User Surveys security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: value: type: string feedback: type: string origin: type: string required: - value delete: summary: tags: - User Surveys security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer kind: type: string value: type: string feedback: type: string origin: type: string user_id: type: integer created_at: type: string updated_at: type: string required: - id - user_id - kind - value - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/users/{id}/user_tracks": get: summary: tags: - User Tracks security: [] parameters: - name: id in: path required: true description: ID of user schema: type: integer - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 100000 - name: from in: query description: Filter tracks recorded after this time. Defaults to three days ago schema: type: string format: date-time - name: to in: query description: Filter tracks recorded before this time. Defaults to the current time schema: type: string format: date-time - name: optimize in: query description: Reduce the number of tracked coordinates before pagination schema: type: boolean default: true responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer user_id: type: integer latitude: type: number longitude: type: number depth: type: number speed: type: number heading: type: number direction: type: number course: type: number source: type: string tracked_at: type: string format: date-time '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object "/api/v1/vessels": get: summary: tags: - Vessels security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - latest_used_at_asc - latest_used_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: sw_latitude in: query description: Filter by bounding box (latitude SW) schema: type: number default: 39.057193 - name: sw_longitude in: query description: Filter by bounding box (longitude SW) schema: type: number default: -76.831734 - name: ne_latitude in: query description: Filter by bounding box (latitude NE) schema: type: number default: 39.970224 - name: ne_longitude in: query description: Filter by bounding box (longitude NE) schema: type: number default: -75.442673 responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string post: summary: tags: - Vessels security: [] parameters: [] responses: '201': description: Respond created content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at errors: type: object properties: field: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number lat: type: string lng: type: string latitude: type: number longitude: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string poi_vessel_id: type: integer port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer ignore_geocoded: type: boolean current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - name - boat_type - draft - buffer - created_at - updated_at "/api/v1/vessels/{id}": get: summary: tags: - Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string put: summary: tags: - Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string requestBody: content: application/json: schema: type: object properties: name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number lat: type: string lng: type: string latitude: type: number longitude: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string poi_vessel_id: type: integer port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer ignore_geocoded: type: boolean current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - name - boat_type - draft - buffer - created_at - updated_at delete: summary: tags: - Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string message: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/vessels/{id}/copy": post: summary: tags: - Vessels security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: message: type: string status: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: id: type: integer name: type: string mmsi_number: type: string length: type: number draft: type: number beam: type: number boat_type: type: string average_speed: type: number user_id: type: integer poi_vessel_id: type: integer original_id: type: integer created_at: type: string updated_at: type: string lat: type: number lng: type: number height: type: number buffer: type: number manufacturer_model: type: string fuel_type: type: string fuel_consumption: type: string port: type: string port_name: type: string homeport_type: type: string homeport_id: type: integer current: type: boolean registration_renewal_date: type: string format: date notes: type: string required: - id - user_id - name - boat_type - draft - buffer - created_at - updated_at errors: type: object properties: field: type: array items: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string "/api/v1/voyages": get: summary: tags: - Voyages security: [] parameters: - name: keyword in: query description: Filter by Keyword schema: type: string - name: page in: query description: Actual page schema: type: integer default: 1 - name: page_total in: query description: Items per page schema: type: integer default: 20 - name: pagination_info in: query description: Add Pagination info to request schema: type: boolean - name: order in: query description: Order by schema: type: string enum: - name_asc - name_desc - updated_at_asc - updated_at_desc - name: user_id in: query description: Filter by User schema: type: integer - name: selected_voyages in: query description: Filter by Selected voyages schema: type: boolean - name: coordinates_format in: query description: Specify coordinate params schema: type: string enum: - short - long responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: pagination: type: object properties: total_items: type: integer page_items: type: integer total_pages: type: integer prev_page: type: integer next_page: type: integer items: type: array items: type: object properties: id: type: integer voyage_type: type: string user_id: type: integer origin: type: string uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string favorite: type: boolean favorite_datetime: type: string manual_route: type: boolean taken: type: boolean offline: type: boolean draft: type: numeric buffer: type: numeric average_speed: type: numeric fuel_type: type: string fuel_consumption: type: string vessel_id: type: string boat_name: type: string manufacturer_model: type: string height: type: string created_at: type: string updated_at: type: string track_locations: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string course_locations: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string '422': description: Respond unprocessable entity content: application/json: schema: type: object properties: status: type: string message: type: string errors: type: object properties: field: type: array items: type: string "/api/v1/voyages/{id}": get: summary: tags: - Voyages security: [] parameters: - name: id in: path required: true description: ID of entity schema: type: integer responses: '200': description: Respond ok content: application/json: schema: type: object properties: status: type: string data: type: object properties: id: type: integer voyage_type: type: string user_id: type: integer origin: type: string uid: type: string name: type: string description: type: string start_date: type: string end_date: type: string favorite: type: boolean favorite_datetime: type: string manual_route: type: boolean taken: type: boolean offline: type: boolean draft: type: numeric buffer: type: numeric average_speed: type: numeric fuel_type: type: string fuel_consumption: type: string vessel_id: type: string boat_name: type: string manufacturer_model: type: string height: type: string created_at: type: string updated_at: type: string track_locations: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string course_locations: type: array items: type: object properties: id: type: integer lat: type: string lng: type: string depth: type: string '404': description: Respond not found content: application/json: schema: type: object properties: message: type: string status: type: string servers: []