{"_id":"57459c10a488e817005418ab","user":"56267741db1eda0d001c3dbb","__v":2,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":34,"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","595412446ed4d9001b3e7b37","59e76ce41938310028037295"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"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"},"parentDoc":null,"project":"55faeacad0e22017005b8265","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-25T12:35:28.438Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":35,"body":"| Table of Contents |\n| --- |\n| [Basic Shape Search](#section-basic-shape-search) |\n| [Shape Search by Term](#section-shape-search-by-term) |\n| [Shape Search by Geometry and Term](#section-shape-search-by-geometry-and-term) |\n\n#Basic Shape Search#\n\nDon'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](#section-shape-search-by-term), or the more specific [geometry and item type](#section-shape-search-by-geometry-and-term).\n\n##Step 1: List Vector Ingest Sources##\n\nIf the user is just browsing, the best way to get a sense for the results is to [see what ingest sources exist](doc:shape-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\n##Step 2: List Vector Geometries##\n\nAfter viewing the ingest sources available within the aoi, the user can then dig into each ingest source for the [geometries available](doc:shape-list-vector-geometries). Each ingest source has different geometries available.\n\n##Step 3: List Vector Item Types##\n\nAfter viewing the geometries available per ingest source within the aoi, the user can then dig into each geometry for the [item types available](doc:shape-list-vector-types). Each ingest source and geometry has different item types available.\n\n##Step 4: Get Paging ID##\n\nNow that the user has seen the ingest sources, geometries, and the item types of interest, they can gain the actual vector items, based on the vector item type they select. For shape calls, the user must use [paging to retrieve the results](doc:shape-get-paging-id).\n\n##Step 5: Retrieve Page of Vector Items##\n\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 in the case of a basic search over an irregular aoi, it is the only option.\n\n\n#Shape Search by Term#\n\nHave an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by term does not require the user to know anything beyond the basic concept of what they are looking for, and the only results returned will match that query. For the item type and term variation of the Vector Services query, go [here](#section-shape-search-by-geometry-and-term).\n\nDon't know what you're looking for? Start with a [basic search](#section-basic-shape-search).\n\n**For more information** on querying and query construction, check the [Query Syntax, Fields, and Item Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) page and [Vector Services Example Query Constructions](doc:vector-services-example-query-constructions) page.\n\n##Step 1: List Vector Items OR Get Paging ID##\n\nSince the user already has an idea of what they are searching for, they can immediately begin the process of gaining the actual vector items. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply [get the vector items in one go](doc:shape-query-list-vector-items).\n\nHowever, if there are more than 1000 vector items to retrieve, the user must use [paging to retrieve the results](doc:shape-query-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\n##Step 2: Retrieve Page of Vector Items##\n\nAfter acquiring the paging ID, 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 both steps to acquire everything they need from the Vector Services.\n\n#Shape Search by Geometry and Term#\nHave an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by item geometry, item type, and term does not initially require the user to know anything beyond the basic concept of what they are looking for, and the user may then narrow down results based on item type. For the term variation of the Vector Services query, go [here](#section-shape-search-by-term).\n\nDon't know what you're looking for? Start with a [basic search](#section-basic-shape-search).\n\n**For more information** on querying and query construction, check the [Query Syntax, Fields, and Item Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) page and [Vector Services Example Query Constructions](doc:vector-services-example-query-constructions) page.\n\n##Step 1: List Vector Geometries##\nSince the user has an idea of what they are searching for, they can begin with a query for a term to [see what geometry types are available](doc:shape-query-list-vector-geometries).\n\n##Step 2: List Vector Item Types##\nNow that the user has seen the geometry types that align with their term, they can dig in to [see what item types are available](doc:shape-query-list-vector-types).\n\n##Step 3: Get Paging ID##\nNow that the user has seen the geometry types and the item types of interest for their term, they can gain the actual vector items, based on the vector item type they select. For shape calls, the user must use [paging to retrieve the results](doc:shape-query-get-paging-id-with-geometry-and-type).\n\n##Step 4: Retrieve Page of Vector Items##\nAfter acquiring the paging ID, 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 in this instance is the only method to retrieve vector items.","excerpt":"The workflow of API requests in which a user sends when using the Vector Services","slug":"lesson-vector-services-shape-searching","type":"basic","title":"Lesson: Vector Services Shape Searching"}

Lesson: Vector Services Shape Searching

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

| Table of Contents | | --- | | [Basic Shape Search](#section-basic-shape-search) | | [Shape Search by Term](#section-shape-search-by-term) | | [Shape Search by Geometry and Term](#section-shape-search-by-geometry-and-term) | #Basic Shape Search# 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](#section-shape-search-by-term), or the more specific [geometry and item type](#section-shape-search-by-geometry-and-term). ##Step 1: List Vector Ingest Sources## If the user is just browsing, the best way to get a sense for the results is to [see what ingest sources exist](doc:shape-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. ##Step 2: List Vector Geometries## After viewing the ingest sources available within the aoi, the user can then dig into each ingest source for the [geometries available](doc:shape-list-vector-geometries). Each ingest source has different geometries available. ##Step 3: List Vector Item Types## After viewing the geometries available per ingest source within the aoi, the user can then dig into each geometry for the [item types available](doc:shape-list-vector-types). Each ingest source and geometry has different item types available. ##Step 4: Get Paging ID## Now that the user has seen the ingest sources, geometries, and the item types of interest, they can gain the actual vector items, based on the vector item type they select. For shape calls, the user must use [paging to retrieve the results](doc:shape-get-paging-id). ##Step 5: Retrieve Page of Vector Items## 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 in the case of a basic search over an irregular aoi, it is the only option. #Shape Search by Term# Have an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by term does not require the user to know anything beyond the basic concept of what they are looking for, and the only results returned will match that query. For the item type and term variation of the Vector Services query, go [here](#section-shape-search-by-geometry-and-term). Don't know what you're looking for? Start with a [basic search](#section-basic-shape-search). **For more information** on querying and query construction, check the [Query Syntax, Fields, and Item Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) page and [Vector Services Example Query Constructions](doc:vector-services-example-query-constructions) page. ##Step 1: List Vector Items OR Get Paging ID## Since the user already has an idea of what they are searching for, they can immediately begin the process of gaining the actual vector items. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply [get the vector items in one go](doc:shape-query-list-vector-items). However, if there are more than 1000 vector items to retrieve, the user must use [paging to retrieve the results](doc:shape-query-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. ##Step 2: Retrieve Page of Vector Items## After acquiring the paging ID, 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 both steps to acquire everything they need from the Vector Services. #Shape Search by Geometry and Term# Have an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by item geometry, item type, and term does not initially require the user to know anything beyond the basic concept of what they are looking for, and the user may then narrow down results based on item type. For the term variation of the Vector Services query, go [here](#section-shape-search-by-term). Don't know what you're looking for? Start with a [basic search](#section-basic-shape-search). **For more information** on querying and query construction, check the [Query Syntax, Fields, and Item Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) page and [Vector Services Example Query Constructions](doc:vector-services-example-query-constructions) page. ##Step 1: List Vector Geometries## Since the user has an idea of what they are searching for, they can begin with a query for a term to [see what geometry types are available](doc:shape-query-list-vector-geometries). ##Step 2: List Vector Item Types## Now that the user has seen the geometry types that align with their term, they can dig in to [see what item types are available](doc:shape-query-list-vector-types). ##Step 3: Get Paging ID## Now that the user has seen the geometry types and the item types of interest for their term, they can gain the actual vector items, based on the vector item type they select. For shape calls, the user must use [paging to retrieve the results](doc:shape-query-get-paging-id-with-geometry-and-type). ##Step 4: Retrieve Page of Vector Items## After acquiring the paging ID, 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 in this instance is the only method to retrieve vector items.