-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_data.js
More file actions
1541 lines (1541 loc) · 83.3 KB
/
api_data.js
File metadata and controls
1541 lines (1541 loc) · 83.3 KB
1
define({ "api": [ { "type": "post", "url": "/authenticate", "title": "Create", "permission": [ { "name": "App Token" } ], "name": "CreateAuthentication", "group": "Authentication", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Api-Token", "description": "<p>App unique access-token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/authenticate \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJe24w\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "email", "description": "<p>Email of client.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "password", "description": "<p>Password of client.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/authenticate \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJe24w\" \\\n -d client[email]=larry@dronebase.com \\\n -d client[password]=hard_password", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "first_name", "description": "<p>First name of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "last_name", "description": "<p>last name of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "email", "description": "<p>Email of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "token", "description": "<p>Used to authorize client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "type", "description": "<p>Indicating the type of User.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n first_name: \"Jim\",\n last_name: \"Jam\",\n email: \"jimjam@me.com\"\n token: \"qEXrMhCVQu_9JhfeZv7McFTJAww\"\n type: \"client\"\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/sessions_controller.rb", "groupTitle": "Authentication" }, { "type": "post", "url": "/clients", "title": "Create", "permission": [ { "name": "App Token" } ], "name": "CreateClient", "group": "Client", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Api-Token", "description": "<p>App unique access-token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJe24w\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "first_name", "description": "<p>First name of client.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "last_name", "description": "<p>last name of client.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "email", "description": "<p>Email of client.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "phone", "description": "<p>Contact phone of client.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "password", "description": "<p>Password chosen by client.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl http://api.lvh.me:3000/v1/clients \\\n -H \"X-Api-Format: flattenjson\" \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJefw\" \\\n -d first_name=Larry \\\n -d last_name=Sprock \\\n -d email=larry+2@dronebase.com \\\n -d phone=1-323-228-3625 \\\n -d password=hard_password", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "" }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "first_name", "description": "<p>First name of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "last_name", "description": "<p>last name of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "phone", "description": "<p>Contact phone of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "email", "description": "<p>Email of client.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "token", "description": "<p>Used to authorize client.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n \"id\": \"DBC3500561\",\n \"first_name\": \"Larry\",\n \"last_name\": \"Sprock\",\n \"phone\": \"+1 323-228-3625\",\n \"email\": \"larry2@dronebase.com\",\n \"token\": \"EhEab7bpzjM3tEBbpX5H5ChF7gk\"\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients_controller.rb", "groupTitle": "Client" }, { "type": "post", "url": "/clients/credit_cards", "title": "Create", "permission": [ { "name": "Client Email & Token" } ], "name": "CreateCreditCard", "group": "Client_CreditCards", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/credit_cards \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "provider_token", "description": "<p>A credit card token provided by our payment processor.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\" \\\n -d provider_token=tok_15zAxJJo202eeWudho4BMMoM", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>Credit Card record id</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "brand", "description": "<p>Credit Card type</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "last_4", "description": "<p>Last 4 digits of the credit card.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "exp_month", "description": "<p>The expiration month number of the credit card.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "exp_year", "description": "<p>The expiration year of the credit card.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n id: 23,\n brand: 'visa',\n last_4: 2345,\n exp_month: \"10\",\n exp_year: \"2029\"\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/credit_cards_controller.rb", "groupTitle": "Client_CreditCards" }, { "type": "post", "url": "/clients/locations", "title": "Create", "permission": [ { "name": "Client Email & Token" } ], "name": "CreateLocation", "group": "Client_Locations", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/locations \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>Float</p> ", "optional": false, "field": "latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Parameter", "type": "<p>Float</p> ", "optional": false, "field": "longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "city", "description": "<p>City of the mission.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "state", "description": "<p>State of the mission.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "postal_code", "description": "<p>Postal code of the mission.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\" \\\n -d latitude=34.047635 \\\n -d longitude=-118.463419 \\\n -d address=\"11835 Wilshire Blvd\" \\\n -d address2=\"Suite 10\" \\\n -d city=\"Santa Monica\" \\\n -d state=\"CA\" \\\n -d postal_code=\"90025", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>Location record id</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "name", "description": "<p>Name of the location</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "city", "description": "<p>City of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "state", "description": "<p>State of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "postal_code", "description": "<p>Postal code of the mission.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "properties", "description": "<p>These are mapping coordinance to use for marking properties.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n id: 23,\n name: 'Main Property 46th St'\n latitude: l34.047635,\n longitude: -118.463419,\n address: \"1526 14th St\",\n address2: \"Suite 106\",\n city: \"Santa Monica\",\n state: \"CA\",\n postal_code: \"90404\",\n properties: {...}\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/locations_controller.rb", "groupTitle": "Client_Locations" }, { "type": "get", "url": "/clients/locations/:id", "title": "Show", "permission": [ { "name": "Client Email & Token" } ], "name": "ShowLocation", "group": "Client_Locations", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/locations/23 \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>Location record id</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "name", "description": "<p>Name of the location</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "city", "description": "<p>City of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "state", "description": "<p>State of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "postal_code", "description": "<p>Postal code of mission location.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "properties", "description": "<p>These are mapping coordinance to use for marking properties.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n id: 23,\n name: 'Main Property 46th St'\n latitude: l34.047635,\n longitude: -118.463419,\n address: \"1526 14th St\",\n address2: \"Suite 106\",\n city: \"Santa Monica\",\n state: \"CA\",\n postal_code: \"90404\",\n properties: {...}\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/locations_controller.rb", "groupTitle": "Client_Locations" }, { "type": "post", "url": "/clients/missions", "title": "Create", "permission": [ { "name": "Client Email & Token" } ], "name": "CreateMission", "group": "Client_Missions", "description": "<p>One of the things to note about a Mission is that it has a couple dependencies.<br> The first is a <a href=\"#api-Packages-GetPackages\">package</a> and the second is a <a href=\"#api-Client_Locations-CreateLocation\">location</a>. See docs for getting the needed ids.</p> ", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/missions \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>Text</p> ", "optional": false, "field": "instructions", "description": "<p>These are client instructions.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "category", "description": "<p>The category this mission.</p> " }, { "group": "Parameter", "type": "<p>Integer</p> ", "optional": false, "field": "package_id", "description": "<p>The package id to associate with the mission.<br> slasdjsadjasldjklasjkldasj</p> " }, { "group": "Parameter", "type": "<p>Integer</p> ", "optional": false, "field": "location_id", "description": "<p>The location id to associate with the mission.</p> " }, { "group": "Parameter", "type": "<p>Integer</p> ", "optional": false, "field": "credit_card_id", "description": "<p>The credit card id to associate with the mission.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\" \\\n -d instructions=\"Do something cool\" \\\n -d category=\"Real Estate\" \\\n -d package_id=1 \\\n -d location_id=23", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "location.id", "description": "<p>Location record id</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.city", "description": "<p>City of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.state", "description": "<p>State of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.postal_code", "description": "<p>Postal code of the mission.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n \"data\": {\n \"id\": \"DBM1142354\",\n \"type\": \"missions\",\n \"attributes\": {\n \"instructions\": \"Please make this awesome.\",\n \"status\": \"Created\",\n \"client_id\": 51,\n \"created_on\": \"2015-09-08T20:17:22Z\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"type\": \"locations\",\n \"id\": \"70\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"3\"\n }\n },\n \"credit_card\": {\n \"data\": {\n \"type\": \"credit_cards\",\n \"id\": \"18\"\n }\n },\n \"images\": {\n \"data\": [\n {\n \"type\": \"images\",\n \"id\": \"180\"\n },\n {\n \"type\": \"images\",\n \"id\": \"179\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"images\",\n \"id\": \"180\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"70\",\n \"type\": \"locations\",\n \"attributes\": {\n \"name\": \"Apple, Infinite Loop, Cupertino, CA, United States\",\n \"latitude\": null,\n \"longitude\": null,\n \"address\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country\": null,\n \"properties\": {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -122.02780103041073,\n 37.33401715997264\n ],\n [\n -122.02999169577026,\n 37.333859342911005\n ],\n [\n -122.03203215742502,\n 37.33361621868083\n ],\n [\n -122.03187122488413,\n 37.331744185594594\n ],\n [\n -122.03078662104036,\n 37.33162901834106\n ],\n [\n -122.0304315780487,\n 37.33064369128805\n ],\n [\n -122.0278868610992,\n 37.33043041533282\n ],\n [\n -122.02780103041073,\n 37.33401715997264\n ]\n ]\n ]\n },\n \"properties\": {\n \"type\": \"Property Area\",\n \"name\": \"Apple HQ - Infinite Loop\",\n \"notes\": \"We'd like to create a marketing video showcasing Apple HQ and the surrounding parking area from the air. \\n\\nThere are many features to our property that we'd like to showcase. \",\n \"area\": 118561,\n \"bounds\": {\n \"Ja\": {\n \"G\": 37.33043041533282,\n \"j\": 37.33401715997264\n },\n \"Ea\": {\n \"j\": -122.03203215742502,\n \"G\": -122.02780103041073\n }\n },\n \"center\": {\n \"G\": 37.33222378765273,\n \"K\": -122.02991659391785\n }\n },\n \"id\": 1\n },\n Ect...\n ]\n }\n }\n },\n {\n \"id\": \"3\",\n \"type\": \"packages\",\n \"attributes\": {\n \"name\": \"Business\",\n \"description\": \" - Produced highlight reel of all the best video of two properties\\n - Custom branding, messaging, and contact info\\n - 10-15 High resolution images for each property\\n - All high definition videos (unedited) for each property\\n - 1-2 Week turnaround\\n - Two locations\\n\",\n \"price\": 89900\n },\n \"relationships\": {\n \"mission_type\": {\n \"data\": {\n \"type\": \"mission_types\",\n \"id\": \"1\"\n }\n }\n }\n },\n {\n \"id\": \"1\",\n \"type\": \"mission_types\",\n \"attributes\": {\n \"name\": \"Images + Video\"\n }\n },\n {\n \"id\": \"18\",\n \"type\": \"credit_cards\",\n \"attributes\": {\n \"brand\": \"Visa\",\n \"last_4\": \"4242\",\n \"exp_month\": 12,\n \"exp_year\": 2023\n }\n },\n {\n \"id\": \"180\",\n \"type\": \"images\",\n \"attributes\": {\n \"url\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/original-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"version_urls\": {\n \"large_1920\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/large_1920-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"medium_1024\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/medium_1024-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"small_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/small_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"square_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/square_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"download\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/downloadable-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\"\n },\n \"mission_id\": 1289,\n \"size\": 4768806,\n \"height\": 2086,\n \"width\": 3708,\n \"resolution\": 72,\n \"gps_latitude\": null,\n \"gps_longitude\": null,\n \"gps_altitude\": null,\n \"processing\": false\n }\n },\n {\n \"id\": \"179\",\n \"type\": \"images\",\n \"attributes\": {\n \"url\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/original-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"version_urls\": {\n \"large_1920\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/large_1920-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"medium_1024\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/medium_1024-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"small_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/small_640-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"square_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/square_640-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"download\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/downloadable-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\"\n },\n \"mission_id\": 1289,\n \"size\": 3693963,\n \"height\": 2250,\n \"width\": 4000,\n \"resolution\": 72,\n \"gps_latitude\": 40.6875554444444,\n \"gps_longitude\": -73.9603404166667,\n \"gps_altitude\": 50.2,\n \"processing\": false\n }\n }\n ]\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/missions_controller.rb", "groupTitle": "Client_Missions" }, { "type": "get", "url": "/clients/missions", "title": "Index", "permission": [ { "name": "Client Email & Token" } ], "name": "GetMissions", "group": "Client_Missions", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/missions \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n \"data\": [\n {\n \"id\": \"DBM1142354\",\n \"type\": \"missions\",\n \"attributes\": {\n \"instructions\": \"Please make this awesome.\",\n \"status\": \"Created\",\n \"client_id\": 51,\n \"created_on\": \"2015-09-08T20:17:22Z\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"type\": \"locations\",\n \"id\": \"70\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"3\"\n }\n },\n \"credit_card\": {\n \"data\": {\n \"type\": \"credit_cards\",\n \"id\": \"18\"\n }\n },\n \"images\": {\n \"data\": [\n {\n \"type\": \"images\",\n \"id\": \"180\"\n },\n {\n \"type\": \"images\",\n \"id\": \"179\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"images\",\n \"id\": \"180\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"70\",\n \"type\": \"locations\",\n \"attributes\": {\n \"name\": \"Apple, Infinite Loop, Cupertino, CA, United States\",\n \"latitude\": null,\n \"longitude\": null,\n \"address\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country\": null,\n \"properties\": {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -122.02780103041073,\n 37.33401715997264\n ],\n [\n -122.02999169577026,\n 37.333859342911005\n ],\n [\n -122.03203215742502,\n 37.33361621868083\n ],\n [\n -122.03187122488413,\n 37.331744185594594\n ],\n [\n -122.03078662104036,\n 37.33162901834106\n ],\n [\n -122.0304315780487,\n 37.33064369128805\n ],\n [\n -122.0278868610992,\n 37.33043041533282\n ],\n [\n -122.02780103041073,\n 37.33401715997264\n ]\n ]\n ]\n },\n \"properties\": {\n \"type\": \"Property Area\",\n \"name\": \"Apple HQ - Infinite Loop\",\n \"notes\": \"We'd like to create a marketing video showcasing Apple HQ and the surrounding parking area from the air. \\n\\nThere are many features to our property that we'd like to showcase. \",\n \"area\": 118561,\n \"bounds\": {\n \"Ja\": {\n \"G\": 37.33043041533282,\n \"j\": 37.33401715997264\n },\n \"Ea\": {\n \"j\": -122.03203215742502,\n \"G\": -122.02780103041073\n }\n },\n \"center\": {\n \"G\": 37.33222378765273,\n \"K\": -122.02991659391785\n }\n },\n \"id\": 1\n }\n ]\n }\n }\n },\n {\n \"id\": \"3\",\n \"type\": \"packages\",\n \"attributes\": {\n \"name\": \"Business\",\n \"description\": \" - Produced highlight reel of all the best video of two properties\\n - Custom branding, messaging, and contact info\\n - 10-15 High resolution images for each property\\n - All high definition videos (unedited) for each property\\n - 1-2 Week turnaround\\n - Two locations\\n\",\n \"price\": 89900\n },\n \"relationships\": {\n \"mission_type\": {\n \"data\": {\n \"type\": \"mission_types\",\n \"id\": \"1\"\n }\n }\n }\n },\n {\n \"id\": \"1\",\n \"type\": \"mission_types\",\n \"attributes\": {\n \"name\": \"Images + Video\"\n }\n },\n {\n \"id\": \"18\",\n \"type\": \"credit_cards\",\n \"attributes\": {\n \"brand\": \"Visa\",\n \"last_4\": \"4242\",\n \"exp_month\": 12,\n \"exp_year\": 2023\n }\n },\n {\n \"id\": \"180\",\n \"type\": \"images\",\n \"attributes\": {\n \"url\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/original-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"version_urls\": {\n \"large_1920\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/large_1920-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"medium_1024\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/medium_1024-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"small_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/small_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"square_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/square_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"download\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/downloadable-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\"\n },\n \"mission_id\": 1289,\n \"size\": 4768806,\n \"height\": 2086,\n \"width\": 3708,\n \"resolution\": 72,\n \"gps_latitude\": null,\n \"gps_longitude\": null,\n \"gps_altitude\": null,\n \"processing\": false\n }\n }\n ]\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/missions_controller.rb", "groupTitle": "Client_Missions" }, { "type": "get", "url": "/clients/missions/:id", "title": "Show", "permission": [ { "name": "Client Email & Token" } ], "name": "ShowMission", "group": "Client_Missions", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Client email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/clients/missions/10022 \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n \"data\": {\n \"id\": \"DBM1142354\",\n \"type\": \"missions\",\n \"attributes\": {\n \"instructions\": \"Please make this awesome.\",\n \"status\": \"Created\",\n \"client_id\": 51,\n \"created_on\": \"2015-09-08T20:17:22Z\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"type\": \"locations\",\n \"id\": \"70\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"3\"\n }\n },\n \"credit_card\": {\n \"data\": {\n \"type\": \"credit_cards\",\n \"id\": \"18\"\n }\n },\n \"images\": {\n \"data\": [\n {\n \"type\": \"images\",\n \"id\": \"180\"\n },\n {\n \"type\": \"images\",\n \"id\": \"179\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"images\",\n \"id\": \"180\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"70\",\n \"type\": \"locations\",\n \"attributes\": {\n \"name\": \"Apple, Infinite Loop, Cupertino, CA, United States\",\n \"latitude\": null,\n \"longitude\": null,\n \"address\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country\": null,\n \"properties\": {\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -122.02780103041073,\n 37.33401715997264\n ],\n [\n -122.02999169577026,\n 37.333859342911005\n ],\n [\n -122.03203215742502,\n 37.33361621868083\n ],\n [\n -122.03187122488413,\n 37.331744185594594\n ],\n [\n -122.03078662104036,\n 37.33162901834106\n ],\n [\n -122.0304315780487,\n 37.33064369128805\n ],\n [\n -122.0278868610992,\n 37.33043041533282\n ],\n [\n -122.02780103041073,\n 37.33401715997264\n ]\n ]\n ]\n },\n \"properties\": {\n \"type\": \"Property Area\",\n \"name\": \"Apple HQ - Infinite Loop\",\n \"notes\": \"We'd like to create a marketing video showcasing Apple HQ and the surrounding parking area from the air. \\n\\nThere are many features to our property that we'd like to showcase. \",\n \"area\": 118561,\n \"bounds\": {\n \"Ja\": {\n \"G\": 37.33043041533282,\n \"j\": 37.33401715997264\n },\n \"Ea\": {\n \"j\": -122.03203215742502,\n \"G\": -122.02780103041073\n }\n },\n \"center\": {\n \"G\": 37.33222378765273,\n \"K\": -122.02991659391785\n }\n },\n \"id\": 1\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -122.03092312170406,\n 37.331594417425194\n ],\n [\n -122.03194632673643,\n 37.33157735558697\n ],\n [\n -122.03194632673643,\n 37.33137735681337\n ],\n [\n -122.0319745476379,\n 37.331309109240046\n ],\n [\n -122.03197186542889,\n 37.33043349580932\n ],\n [\n -122.0313428874149,\n 37.33043077009093\n ],\n [\n -122.0307139094009,\n 37.33063278930754\n ],\n [\n -122.03092312170406,\n 37.331594417425194\n ]\n ]\n ]\n },\n \"properties\": {\n \"type\": \"No Fly Zone\",\n \"name\": \"Not our property\",\n \"notes\": \"This is not Apple HQ property\",\n \"area\": 12661,\n \"bounds\": {\n \"Ia\": {\n \"G\": 37.33043077009093,\n \"j\": 37.331594417425194\n },\n \"Ca\": {\n \"j\": -122.0319745476379,\n \"G\": -122.0307139094009\n }\n },\n \"center\": {\n \"G\": 37.33101259375806,\n \"K\": -122.0313442285194\n }\n },\n \"id\": 2\n },\n {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -122.0296912883606,\n 37.33186124713385\n ]\n },\n \"properties\": {\n \"type\": \"Point of Interest\",\n \"name\": \"Courtyard\",\n \"notes\": \"Please highlight the main courtyard in the middle of our property\"\n },\n \"id\": 3\n }\n ]\n }\n }\n },\n {\n \"id\": \"3\",\n \"type\": \"packages\",\n \"attributes\": {\n \"name\": \"Business\",\n \"description\": \" - Produced highlight reel of all the best video of two properties\\n - Custom branding, messaging, and contact info\\n - 10-15 High resolution images for each property\\n - All high definition videos (unedited) for each property\\n - 1-2 Week turnaround\\n - Two locations\\n\",\n \"price\": 89900\n },\n \"relationships\": {\n \"mission_type\": {\n \"data\": {\n \"type\": \"mission_types\",\n \"id\": \"1\"\n }\n }\n }\n },\n {\n \"id\": \"1\",\n \"type\": \"mission_types\",\n \"attributes\": {\n \"name\": \"Images + Video\"\n }\n },\n {\n \"id\": \"18\",\n \"type\": \"credit_cards\",\n \"attributes\": {\n \"brand\": \"Visa\",\n \"last_4\": \"4242\",\n \"exp_month\": 12,\n \"exp_year\": 2023\n }\n },\n {\n \"id\": \"180\",\n \"type\": \"images\",\n \"attributes\": {\n \"url\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/original-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"version_urls\": {\n \"large_1920\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/large_1920-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"medium_1024\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/medium_1024-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"small_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/small_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"square_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/square_640-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\",\n \"download\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/180-33651a96f001b27f7be6d9e676a65fe429ff8920/downloadable-7ad0c32b70e63884d35a8211942bf90138e10402.jpg\"\n },\n \"mission_id\": 1289,\n \"size\": 4768806,\n \"height\": 2086,\n \"width\": 3708,\n \"resolution\": 72,\n \"gps_latitude\": null,\n \"gps_longitude\": null,\n \"gps_altitude\": null,\n \"processing\": false\n }\n },\n {\n \"id\": \"179\",\n \"type\": \"images\",\n \"attributes\": {\n \"url\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/original-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"version_urls\": {\n \"large_1920\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/large_1920-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"medium_1024\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/medium_1024-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"small_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/small_640-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"square_640\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/square_640-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\",\n \"download\": \"https://dronebase-development.s3.amazonaws.com/assets/mission/images/179-b1eae612d6343a1b85205d7ffa7cf647581a4e62/downloadable-d4e53cfe023c75a4f4f2f907dee3fa7ae0eea1b0.JPG\"\n },\n \"mission_id\": 1289,\n \"size\": 3693963,\n \"height\": 2250,\n \"width\": 4000,\n \"resolution\": 72,\n \"gps_latitude\": 40.6875554444444,\n \"gps_longitude\": -73.9603404166667,\n \"gps_altitude\": 50.2,\n \"processing\": false\n }\n }\n ]\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/clients/missions_controller.rb", "groupTitle": "Client_Missions" }, { "type": "get", "url": "/packages", "title": "Index", "permission": [ { "name": "App Token" } ], "name": "GetPackages", "group": "Packages", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Api-Token", "description": "<p>App unique access-token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/mission/packages \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJe24w\"", "type": "bash" } ] }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>The id of the package.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "name", "description": "<p>Name of the package.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "type_name", "description": "<p>This is the group name for the package. Several packages may share this name.</p> " }, { "group": "Success 200", "type": "<p>Text</p> ", "optional": false, "field": "description", "description": "<p>The is a description of the package. It is written in <a href=\"http://daringfireball.net/projects/markdown/syntax\">Markdown</a>.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "price", "description": "<p>This is the price of the package. Price is returned in cents.</p> " } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n [\n {\n id: 1,\n name: \"Pro\",\n description: \" - This is awesomer mapping stuff\\n - You really need this more for excellent mapping\\n - Lets create some cool stuff with this mapper\\n\",\n price: 59900,\n mission_type: {\n id: 1,\n name: \"Maps + Surveys\"\n }\n },\n etc...\n ]", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/missions/packages_controller.rb", "groupTitle": "Packages" }, { "type": "post", "url": "/pilots", "title": "Create", "permission": [ { "name": "App Token" } ], "name": "CreatePilot", "group": "Pilot", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Api-Token", "description": "<p>App unique access-token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/pilots \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJe24w\"", "type": "bash" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "first_name", "description": "<p>First name of pilot.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "last_name", "description": "<p>last name of pilot.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "email", "description": "<p>Email of pilot.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "password", "description": "<p>Password chosen by pilot.</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "phone", "description": "<p>Requires country code in some instances</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "birthday", "description": "<p>String format mm/dd/yyyy</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "address", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "address2", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "city", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "state", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "postal_code", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "country", "description": "<p>2 letter country code</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "travel_distance", "description": "<p>Distance willing to travel in miles</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "drone_system", "description": "" }, { "group": "Parameter", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "" }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "token", "description": "<p>Api token for authorizing api access</p> " }, { "group": "Parameter", "type": "<p>String</p> ", "optional": false, "field": "status", "description": "<p>Can be one of either "created", "evaluation_completed", "approved" or "rejected"</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl https://api.dronebase.com/v1/pilots \\\n -H \"X-Api-Format: flattenjson\" \\\n -H \"X-Api-Token: bTKW0Hmqhq0Ab464vvJefw\" \\\n -d first_name=Larry \\\n -d last_name=Sprock \\\n -d email=larry@dronebase.com \\\n -d password=hard_password \\\n -d phone=1-323-228-3625 \\\n -d birthday='12/26/1973' \\\n -d address='1234 W 14th St' \\\n -d address2='apt #4' \\\n -d city=\"Santa Monica\" \\\n -d state=California \\\n -d postal_code=90233 \\\n -d country=US \\\n -d travel_distance=50 \\\n -d drone_system='DJI phantom 16'", "type": "bash" } ] }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n \"id\": \"DBP6664355\",\n \"first_name\": \"Larry\",\n \"last_name\": \"Sprock\",\n \"email\": \"larry@dronebase.com\",\n \"token\": \"aeVLi1RcYKxyUjrCxvaMXhYB09A\",\n \"phone\": \"+1 323-806-0195\",\n \"birthday\": \"12/26/1973\",\n \"address\": \"1234 W 14th St\",\n \"address2\": \"apt #4\",\n \"city\": \"Santa Monica\",\n \"state\": \"California\",\n \"postal_code\": \"90233\",\n \"country\": \"US\",\n \"travel_distance\": 50,\n \"drone_system\": \"DJI phantom 16\",\n \"status\": \"created\"\n }", "type": "json" } ] }, "version": "1.0.0", "filename": "./app/controllers/v1/pilots_controller.rb", "groupTitle": "Pilot" }, { "type": "get", "url": "/pilots/missions", "title": "Index", "permission": [ { "name": "Pilot Email & Token" } ], "name": "GetMissions", "group": "Pilot_Missions", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Pilot email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/pilots/missions \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n [\n {\n id: 10022\n status: \"initialized\",\n instructions: \"Do something cool\",\n category: \"Real Estate\",\n package: {\n id: 1,\n name: \"Pro\",\n type_name: \"Maps + Surveys\",\n description: \" - This is awesomer mapping stuff\\n - You really need this more for excellent mapping\\n - Lets create some cool stuff with this mapper\\n\",\n price: 59900\n },\n location: {\n id: 23,\n latitude: l34.047635,\n longitude: -118.463419,\n address: \"1526 14th St\",\n address2: \"Suite 106\",\n city: \"Santa Monica\",\n state: \"CA\",\n postal_code: \"90404\"\n }\n client_id: 27\n },\n etc...\n ]", "type": "json" } ], "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>The id of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "created_on", "description": "<p>This is the time of mission creation. <code>times is utc iso8601</code></p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "status", "description": "<p>Mission status. It can be on of the following <code>['initialized', x, x]</code></p> " }, { "group": "Success 200", "type": "<p>Text</p> ", "optional": false, "field": "instructions", "description": "<p>These are client instructions.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "category", "description": "<p>The category this mission.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "package", "description": "<p>The package associated with the mission.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "package.id", "description": "<p>Package record id.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "package.name", "description": "<p>Name of the package.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "package.type_name", "description": "<p>This is the group name for the package.</p> " }, { "group": "Success 200", "type": "<p>Text</p> ", "optional": false, "field": "package.description", "description": "<p>The is a description of the package. It is written in <a href=\"http://daringfireball.net/projects/markdown/syntax\">Markdown</a>.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "package.price", "description": "<p>This is the price of the package. Price is returned in cents.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "location", "description": "<p>The location where the mission will be executed</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "location.id", "description": "<p>Location record id</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.city", "description": "<p>City of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.state", "description": "<p>State of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.postal_code", "description": "<p>Postal code of the mission.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "client_id", "description": "<p>Client id associated with this mission.</p> " } ] } }, "version": "1.0.0", "filename": "./app/controllers/v1/pilots/missions_controller.rb", "groupTitle": "Pilot_Missions" }, { "type": "get", "url": "/pilots/missions/:id", "title": "Show", "permission": [ { "name": "Pilot Email & Token" } ], "name": "ShowMission", "group": "Pilot_Missions", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>Pilot email and token.</p> " } ] }, "examples": [ { "title": "Example:", "content": "curl {api-url}/pilots/missions/10022 \\\n -H \"Authorization: Token token=bTKW0Hmqhq0Ab464vvJe24w, email=larry@dronebase.com\"", "type": "bash" } ] }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n {\n id: 10022\n status: \"initialized\",\n instructions: \"Do something cool\",\n category: \"Real Estate\",\n package: {\n id: 1,\n name: \"Pro\",\n type_name: \"Maps + Surveys\",\n description: \" - This is awesomer mapping stuff\\n - You really need this more for excellent mapping\\n - Lets create some cool stuff with this mapper\\n\",\n price: 59900\n },\n location: {\n id: 23,\n latitude: l34.047635,\n longitude: -118.463419,\n address: \"1526 14th St\",\n address2: \"Suite 106\",\n city: \"Santa Monica\",\n state: \"CA\",\n postal_code: \"90404\"\n }\n client_id: 27\n }", "type": "json" } ], "fields": { "Success 200": [ { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "id", "description": "<p>The id of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "created_on", "description": "<p>This is the time of mission creation. <code>times is utc iso8601</code></p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "status", "description": "<p>Mission status. It can be on of the following <code>['initialized', x, x]</code></p> " }, { "group": "Success 200", "type": "<p>Text</p> ", "optional": false, "field": "instructions", "description": "<p>These are client instructions.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "category", "description": "<p>The category this mission.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "package", "description": "<p>The package associated with the mission.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "package.id", "description": "<p>Package record id.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "package.name", "description": "<p>Name of the package.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "package.type_name", "description": "<p>This is the group name for the package.</p> " }, { "group": "Success 200", "type": "<p>Text</p> ", "optional": false, "field": "package.description", "description": "<p>The is a description of the package. It is written in <a href=\"http://daringfireball.net/projects/markdown/syntax\">Markdown</a>.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "package.price", "description": "<p>This is the price of the package. Price is returned in cents.</p> " }, { "group": "Success 200", "type": "<p>Object</p> ", "optional": false, "field": "location", "description": "<p>The location where the mission will be executed</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "location.id", "description": "<p>Location record id</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.latitude", "description": "<p>Latitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>Float</p> ", "optional": false, "field": "location.longitude", "description": "<p>Longitudinal coordinates of the location of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address", "description": "<p>Phisical address of the location.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.address2", "description": "<p>Additional address information for the physical address.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.city", "description": "<p>City of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.state", "description": "<p>State of the mission.</p> " }, { "group": "Success 200", "type": "<p>String</p> ", "optional": false, "field": "location.postal_code", "description": "<p>Postal code of the mission.</p> " }, { "group": "Success 200", "type": "<p>Integer</p> ", "optional": false, "field": "client_id", "description": "<p>Client id associated with this mission.</p> " } ] } }, "version": "1.0.0", "filename": "./app/controllers/v1/pilots/missions_controller.rb", "groupTitle": "Pilot_Missions" }] });