{"_id":"56e1d296bc46be0e002af287","category":{"_id":"56e1c96b2506700e00de6e83","version":"55faeacad0e22017005b8268","__v":38,"pages":["56e1ca17cd6a8d0e00d12163","56e1cb0fe416450e00b9e485","56e1cba3cd6a8d0e00d1216c","56e1cc1ae63f910e00e5986b","56e1d0b0cd6a8d0e00d1217f","56e1d15ce416450e00b9e4a3","56e1d23292bf640e00b55663","56e1d296bc46be0e002af287","56e1d305cd6a8d0e00d1218c","56e1d373e416450e00b9e4ab","56e1d38a92bf640e00b55669","56e1d44dbc46be0e002af28e","56e2cb174cd67e220032d655","56e2cf9c1067950e006a16c8","56e2d5ff3987d729008695a0","56e2ddea8ffe6020004c53b2","56e2df768ffe6020004c53bd","56e2e1201067950e006a16f1","56e2e3888ffe6020004c53c5","56e2e53f1067950e006a1702","56e2e9773987d729008695cf","56e2ec731bffb72b00d0562e","56e2ed25b9c88f2900864aab","56e2f0314cd67e220032d6b9","56e2f3c43987d729008695ed","56e2fc3fb9c88f2900864ad7","56e2fe0d3987d7290086960b","56e30180f1ad030e00e72fa7","56e302c228f99e2000a5ffa6","56e3040c6e602e0e00700af6","56e304c5d46bc30e007bb958","56e30650d46bc30e007bb965","56e307456e602e0e00700b08","56e3086251857d0e008e778d","56e3096251857d0e008e7796","56e30a16d46bc30e007bb973","56e30aafd46bc30e007bb97c","56e30aeb51857d0e008e779f"],"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:22:19.658Z","from_sync":false,"order":15,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"user":"56267741db1eda0d001c3dbb","__v":5,"parentDoc":null,"project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":32,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-10T20:01:26.723Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Don't know what you're looking for? To get a good idea about what vectors are available in a given area, start with the basic search. The basic search takes the user step-by-step through the process of seeing what vector items they might want to retrieve. From a basic search, the user must progress through the vector ingest source and the vector item type prior to viewing vector items. If at any point, there is a more specific focus, simply switch from the basic search to querying, either by [term alone](doc:lesson-vs-query-term), or the more specific [item type and term](doc:lesson-vs-query-type-term).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 1: List Vector Ingest Sources\"\n}\n[/block]\nIf the user is just browsing, the best way to get a sense for the results is to [see what ingest sources exist](doc:vs-list-vector-sources) within the chosen area of interest (aoi). This is a basic call, and will return available ingest sources based on both the user's account permissions and the given aoi. This means that users who do not have permissions to see certain ingest sources will not see those ingest sources within the Vector Services even if said ingest sources do exist within the aoi.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 2: List Vector Item Types\"\n}\n[/block]\nAfter viewing the ingest sources available within the aoi, the user can then dig into each ingest source for the [item types available](doc:vs-list-vector-types-given-source). Each ingest source has different item types available.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 3: List Vector Items OR Get Paging ID\"\n}\n[/block]\nNow that the user has seen the ingest sources and the item types of interest, they can begin the process of gaining the actual vector items, based on the vector item type they select. This process is split at this point, based on the results. If there are less than 1000 vector items to retrieve, the user can safely [run a request to simply get the vector items in one go](doc:vs-list-vector-items-given-source-type).\n\nHowever, if there are more than 1000 vector items to retrieve, the user **must** use [paging to retrieve the results](doc:vs-basic-get-paging-id). The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the *count* parameter.\n\nFor simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 4: Retrieve Page of Vector Items\"\n}\n[/block]\nAfter acquiring the paging ID in the last step, the user can then [begin paging requests](doc:vs-retrieve-page-of-vector-items) to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow all four steps to acquire everything they need from the Vector Services.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Step 5: Download Vector Items\"\n}\n[/block]\nIf the user is satisfied with what they see in the retrieved vector items, the user is able to [download the vector items](doc:vs-download-vector-items-for-given-source-and-type) as json for use in other applications.","excerpt":"The workflow of API requests in which a user sends when using the Vector Services","slug":"lesson-vs-basic-search","type":"basic","title":"Lesson: Vector Services Basic Search"}

Lesson: Vector Services Basic Search

The workflow of API requests in which a user sends when using the Vector Services

Don't know what you're looking for? To get a good idea about what vectors are available in a given area, start with the basic search. The basic search takes the user step-by-step through the process of seeing what vector items they might want to retrieve. From a basic search, the user must progress through the vector ingest source and the vector item type prior to viewing vector items. If at any point, there is a more specific focus, simply switch from the basic search to querying, either by [term alone](doc:lesson-vs-query-term), or the more specific [item type and term](doc:lesson-vs-query-type-term). [block:api-header] { "type": "basic", "title": "Step 1: List Vector Ingest Sources" } [/block] If the user is just browsing, the best way to get a sense for the results is to [see what ingest sources exist](doc:vs-list-vector-sources) within the chosen area of interest (aoi). This is a basic call, and will return available ingest sources based on both the user's account permissions and the given aoi. This means that users who do not have permissions to see certain ingest sources will not see those ingest sources within the Vector Services even if said ingest sources do exist within the aoi. [block:api-header] { "type": "basic", "title": "Step 2: List Vector Item Types" } [/block] After viewing the ingest sources available within the aoi, the user can then dig into each ingest source for the [item types available](doc:vs-list-vector-types-given-source). Each ingest source has different item types available. [block:api-header] { "type": "basic", "title": "Step 3: List Vector Items OR Get Paging ID" } [/block] Now that the user has seen the ingest sources and the item types of interest, they can begin the process of gaining the actual vector items, based on the vector item type they select. This process is split at this point, based on the results. If there are less than 1000 vector items to retrieve, the user can safely [run a request to simply get the vector items in one go](doc:vs-list-vector-items-given-source-type). However, if there are more than 1000 vector items to retrieve, the user **must** use [paging to retrieve the results](doc:vs-basic-get-paging-id). The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the *count* parameter. For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead. [block:api-header] { "type": "basic", "title": "Step 4: Retrieve Page of Vector Items" } [/block] After acquiring the paging ID in the last step, the user can then [begin paging requests](doc:vs-retrieve-page-of-vector-items) to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow all four steps to acquire everything they need from the Vector Services. [block:api-header] { "type": "basic", "title": "Step 5: Download Vector Items" } [/block] If the user is satisfied with what they see in the retrieved vector items, the user is able to [download the vector items](doc:vs-download-vector-items-for-given-source-and-type) as json for use in other applications.