{"_id":"564e3a08c475e017007ffb58","__v":4,"parentDoc":null,"project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"user":"55fae9d4825d5f19001fa379","category":{"_id":"561d588d8ca8b90d00210219","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":7,"pages":["561d58cc8ca8b90d0021021a","561d58ea071cd60d000d3202","561d58f88ca8b90d0021021c","564e30acc475e017007ffb43","564e3524e964972100508e6a","564e37deae07512b00a87ddc","564e3a08c475e017007ffb58"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-13T19:16:29.547Z","from_sync":false,"order":9,"slug":"thumbnail-service-guide","title":"Thumbnail Service Guide"},"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T21:07:20.017Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"https://geobigdata.io/thumbnails/v1/thumbnail/104001000AA4B500/256?orientation=maxwidth","name":""}]},"method":"get","results":{"codes":[{"language":"json","status":301,"name":"","code":"301 redirect to http:http://alpha-thumbnail-cache.s3.amazonaws.com/104001000AA4B500/256w.png"}]},"settings":"","auth":"required","params":[{"_id":"564e37deae07512b00a87dde","ref":"","in":"query","required":true,"desc":"The catalog ID of the required image.","default":"","type":"string","name":"catid"},{"_id":"56a7c48097e8b00d0096d229","ref":"","in":"query","required":true,"desc":"256, 512, 1024","default":"","type":"string","name":"dim"},{"_id":"564e3a08c475e017007ffb5a","ref":"","in":"query","required":false,"desc":"standard, maxwidth, maxheight, natres","default":"","type":"string","name":"orientation"}],"url":"/thumbnails/v1/thumbnail/catid/dim?orientation="},"isReference":false,"order":4,"body":"## Dimensions (dim)\n\nIn Thumbnail mode use the numerical value for dimension\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"size\",\n    \"h-1\": \"dimension (use in request)\",\n    \"0-0\": \"small\",\n    \"0-1\": \"256\",\n    \"1-0\": \"medium\",\n    \"1-1\": \"512\",\n    \"2-0\": \"large\",\n    \"2-1\": \"1024\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Orientation \n\nNOTE: All modes maintain aspect ratio\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"standard\",\n    \"0-1\": \"'fit' the image so that the longest extent will not exceed the requested dimension\",\n    \"1-0\": \"maxwidth\",\n    \"1-1\": \"'fit' the image so that the width will not exceed the requested dimension\",\n    \"2-0\": \"maxheight\",\n    \"2-1\": \"'fit' the image so that the height will not exceed the requested dimension\",\n    \"3-0\": \"natres\",\n    \"3-1\": \"Do not 'fit' the image. Use its original extents.\",\n    \"h-0\": \"Orientation\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## IMG Flag:\nYou can add the img=TRUE flag to a thumbnail mode request. This will return an img tag to make the image easily viewable in a web page for testing.\n\neg &img=TRUE The img=TRUE flag will return an img tag to make the image easily viewable in a web page for testing. By default a 301 redirect to a cached image on s3 will be returned.\n\n## Try it Out\n\nTry a thumbnail mode request by copying this example to your browser.You can change the values according to the information provided above.\n\nhttps://geobigdata.io/thumbnails/v1/thumbnail/1050410002946400/256?orientation=maxwidth","excerpt":"Get a thumbnail image GBDX thumbnail service","slug":"thumbnail-mode","type":"endpoint","title":"Thumbnail Mode"}

getThumbnail Mode

Get a thumbnail image GBDX thumbnail service

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

catid:
required
string
The catalog ID of the required image.
dim:
required
string
256, 512, 1024
orientation:
string
standard, maxwidth, maxheight, natres

Examples


Result Format


Documentation

## Dimensions (dim) In Thumbnail mode use the numerical value for dimension [block:parameters] { "data": { "h-0": "size", "h-1": "dimension (use in request)", "0-0": "small", "0-1": "256", "1-0": "medium", "1-1": "512", "2-0": "large", "2-1": "1024" }, "cols": 2, "rows": 3 } [/block] ## Orientation NOTE: All modes maintain aspect ratio [block:parameters] { "data": { "0-0": "standard", "0-1": "'fit' the image so that the longest extent will not exceed the requested dimension", "1-0": "maxwidth", "1-1": "'fit' the image so that the width will not exceed the requested dimension", "2-0": "maxheight", "2-1": "'fit' the image so that the height will not exceed the requested dimension", "3-0": "natres", "3-1": "Do not 'fit' the image. Use its original extents.", "h-0": "Orientation", "h-1": "Description" }, "cols": 2, "rows": 4 } [/block] ## IMG Flag: You can add the img=TRUE flag to a thumbnail mode request. This will return an img tag to make the image easily viewable in a web page for testing. eg &img=TRUE The img=TRUE flag will return an img tag to make the image easily viewable in a web page for testing. By default a 301 redirect to a cached image on s3 will be returned. ## Try it Out Try a thumbnail mode request by copying this example to your browser.You can change the values according to the information provided above. https://geobigdata.io/thumbnails/v1/thumbnail/1050410002946400/256?orientation=maxwidth

User Information

Try It Out


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