{"_id":"57adc2c43f00b90e00b7c95a","__v":2,"user":"543005a67d487022005b3fa7","category":{"_id":"543ee0c055bb1008000955b6","__v":21,"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T21:01:52.185Z","from_sync":false,"order":1,"slug":"iwebcab-api-tools","title":"Gazoop Internal API"},"project":"543005c87d487022005b3fa8","version":{"_id":"543005c87d487022005b3fab","__v":6,"project":"543005c87d487022005b3fa8","createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-12T12:36:20.218Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"[\n\t{\n\t\t\"text\": \"Airports\",\n\t\t\"items\": [\n\t\t\t{\n\t\t\t\t\"val\": \"AI-51.150837|-0.177416|LGW|LGW - London Gatwick Airport\",\n\t\t\t\t\"text\": \"LGW - London Gatwick Airport\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"val\": \"AI-51.469604|-0.453566|LHR|LHR - London Heathrow Airport\",\n\t\t\t\t\"text\": \"LHR - London Heathrow Airport\"\n\t\t\t}\n\t\t]\n\t}\n]"},{"code":"[]","language":"json","status":400,"name":""}]},"settings":"","auth":"never","params":[{"_id":"57adc3aafaa7a10e004495ce","ref":"","in":"body","required":true,"desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","default":"","type":"string","name":"api_key"},{"_id":"57adc3aafaa7a10e004495cd","ref":"","in":"body","required":false,"desc":"This is the mobile number for the customer account.","default":"","type":"int","name":"phone_number"},{"_id":"57adc3aafaa7a10e004495cb","ref":"","in":"body","required":false,"desc":"You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.","default":"","type":"int","name":"customer_pin"},{"_id":"57adc3aafaa7a10e004495ca","ref":"","in":"body","required":true,"desc":"Search Term to use for pulling addresses. You can also use \"airports\" for just airports, and \"last\" for customers latest addresses, and POI for poi's only. For postcode searches, just enter the postcode on its own.","default":"","type":"string","name":"term"}],"url":"/addresses.json"},"isReference":false,"order":999,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What is \\\"text\\\" in the results?\"\n}\n[/block]\nText is the category of the result, these are subject to change. These could be for example \"Airports\", \"Postcodes\", \"Google Places\", \"Foursquare\", \"Fleet Points of Interests\".\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What is the val value?\"\n}\n[/block]\nThe \"val\" is broken up as follows:\n\n**(2 Char KeyType)-(Data)** \n\nBelow are the current two char key types:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key Code\",\n    \"h-1\": \"Key Description\",\n    \"0-0\": \"LL\",\n    \"0-1\": \"**LatLang** - this will return a result of (lat)|(lang)|(text) for example:\\n\\n51.150837|-0.177416|London Gatwick Airport\",\n    \"1-0\": \"AI\",\n    \"1-1\": \"**Airport LatLang** - this will return a result of (lat)|(lang)|(airportIATA)|(text) for example:\\n\\n51.150837|-0.177416|LGW|LGW - London Gatwick Airport\",\n    \"2-0\": \"GP\",\n    \"2-1\": \"**Google Places ID** - This will return a single data code of the place ID only. For example:\\n\\nGP-ChIJ8Zq7csoLdkgRtBUq3Lh45JM\\n\\nWhen a value is selected, you must complete an API call \\\"google_place\\\" to get the text, lat, and long data. Seek [google_place ](/docs/google_place) API\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"This allows you to search addresses using the fleet configuration.","slug":"addresses","type":"endpoint","title":"addresses"}

postaddresses

This allows you to search addresses using the fleet configuration.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

api_key:
required
string
This is a 25 alphanumeric hash code provided to you by the fleet.
phone_number:
integer
This is the mobile number for the customer account.
customer_pin:
integer
You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.
term:
required
string
Search Term to use for pulling addresses. You can also use "airports" for just airports, and "last" for customers latest addresses, and POI for poi's only. For postcode searches, just enter the postcode on its own.

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "What is \"text\" in the results?" } [/block] Text is the category of the result, these are subject to change. These could be for example "Airports", "Postcodes", "Google Places", "Foursquare", "Fleet Points of Interests". [block:api-header] { "type": "basic", "title": "What is the val value?" } [/block] The "val" is broken up as follows: **(2 Char KeyType)-(Data)** Below are the current two char key types: [block:parameters] { "data": { "h-0": "Key Code", "h-1": "Key Description", "0-0": "LL", "0-1": "**LatLang** - this will return a result of (lat)|(lang)|(text) for example:\n\n51.150837|-0.177416|London Gatwick Airport", "1-0": "AI", "1-1": "**Airport LatLang** - this will return a result of (lat)|(lang)|(airportIATA)|(text) for example:\n\n51.150837|-0.177416|LGW|LGW - London Gatwick Airport", "2-0": "GP", "2-1": "**Google Places ID** - This will return a single data code of the place ID only. For example:\n\nGP-ChIJ8Zq7csoLdkgRtBUq3Lh45JM\n\nWhen a value is selected, you must complete an API call \"google_place\" to get the text, lat, and long data. Seek [google_place ](/docs/google_place) API" }, "cols": 2, "rows": 3 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}