Geoservices REST Specification Version 1.0
Total Page:16
File Type:pdf, Size:1020Kb
® An Esri White Paper • September 2010 GeoServices REST Specification Version 1.0 Esri, 380 New York St., Redlands, CA 92373-8100 USA TEL 909-793-2853 • FAX 909-793-5953 • E-MAIL [email protected] • WEB www.esri.com Copyright © 2010 Esri. All rights reserved. Printed in the United States of America. Use of the Esri GeoServices REST Specification is subject to the current Open Web Foundation Agreement found at http://openwebfoundation.org/legal/agreement/. Terms and conditions of the OWF Agreement are subject to change without notice. Notwithstanding any rights granted to the user through the Open Web Foundation (OWF) Agreement, the information contained in this document is the exclusive property of Esri. This work is protected under United States copyright law and other international copyright treaties and conventions. No part of this work may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or by any information storage or retrieval system, except as expressly permitted in writing by Esri. All requests should be sent to Attention: Contracts and Legal Services Manager, Esri, 380 New York Street, Redlands, CA 92373-8100 USA. The information contained in this document is subject to change without notice. Esri, the Esri globe logo, ArcGIS, www.esri.com, and @esri.com are trademarks, registered trademarks, or service marks of Esri in the United States, the European Community, or certain other jurisdictions. Other companies and products mentioned herein may be trademarks or registered trademarks of their respective trademark owners. J-9948 GeoServices REST Specification Version 1.0 An Esri White Paper Contents Page 1.0 INTRODUCTION ................................................................................ 1 1.0.1 Why Implement the GeoServices REST Specification? ........................................................................................ 1 1.0.2 How Do I Implement the GeoServices REST Specification? ........................................................................................ 1 2.0 OVERVIEW OF THE GEOSERVICES REST SPECIFICATION ....................................................................................... 1 2.0.1 Resources and Operations ............................................................ 2 2.0.2 The Role of Services .................................................................... 2 2.0.3 Response Formats ........................................................................ 2 3.0 CATALOG ........................................................................................... 2 3.0.1 Catalog Reference ........................................................................ 2 3.0.2 Catalog Parameters ...................................................................... 2 3.0.3 Catalog Example .......................................................................... 3 4.0 MAP SERVICE .................................................................................... 3 4.0.1 Map Service Reference ................................................................ 4 4.0.2 Map Service Parameters .............................................................. 4 4.0.3 Map Service Example .................................................................. 4 4.0.4 Export Map Operation ................................................................. 7 4.0.4.1 Export Map Reference ........................................................ 7 4.0.4.2 Export Map Parameters ....................................................... 7 4.0.4.3 Export Map Example ........................................................ 11 4.0.5 Identify Operation ...................................................................... 12 4.0.5.1 Identify Reference ............................................................. 12 4.0.5.2 Identify Parameters ........................................................... 12 4.0.5.3 Identify Example ............................................................... 17 4.0.6 Find Operation ........................................................................... 19 4.0.6.1 Find Reference .................................................................. 19 4.0.6.2 Find Parameters ................................................................ 19 4.0.6.3 Find Example .................................................................... 21 Esri White Paper i GeoServices REST Specification Version 1.0 J-9948 Contents Page 4.1 Map Tile ........................................................................................ 22 4.1.1 Map Tile Reference.............................................................. 23 4.1.2 Map Tile Example................................................................ 23 4.2 Layer/Table ................................................................................... 23 4.2.1 Layer/Table Reference ......................................................... 23 4.2.2 Layer/Table Parameters ....................................................... 23 4.2.3 Layer/Table Example ........................................................... 23 4.2.4 Query Operation (Map Service) ........................................... 27 4.2.4.1 Query Reference ......................................................... 28 4.2.4.2 Query Parameters ........................................................ 28 4.2.4.3 Query Examples .......................................................... 33 4.2.5 Query Related Records Operation ....................................... 35 4.2.5.1 Query Related Records Reference .............................. 36 4.2.5.2 Query Related Records Parameters ............................ 36 4.2.5.3 Query Related Records Example ................................ 37 4.3 Feature (Map Service) ................................................................... 39 4.3.1 Feature Reference ................................................................ 39 4.3.2 Feature Parameters ............................................................... 40 4.3.3 Feature Example .................................................................. 40 4.4 Attachment Infos (Map Service) ................................................... 40 4.4.1 Attachment Infos Reference ................................................ 41 4.4.2 Attachment Infos Parameters ............................................... 41 4.4.3 Attachment Infos Example .................................................. 41 4.5 Attachment (Map Service) ............................................................ 42 4.5.1 Attachment Reference .......................................................... 42 4.5.2 Attachment Example ............................................................ 42 4.6 HTML Popup (Map Service) ........................................................ 42 4.6.1 HTML Popup Reference ...................................................... 42 4.6.2 HTML Popup Parameters .................................................... 42 4.6.3 HTML Popup Example ........................................................ 42 4.7 Image............................................................................................. 43 4.7.1 Image Reference .................................................................. 43 4.7.2 Image Example .................................................................... 43 4.8 All Layers and Tables ................................................................... 43 4.8.1 All Layers and Tables Reference ......................................... 43 4.8.2 All Layers and Tables Parameters ....................................... 43 4.8.3 All Layers and Tables Example ........................................... 43 5.0 GEOCODE SERVICE ........................................................................ 46 5.0.1 Geocode Service Reference ....................................................... 47 5.0.2 Geocode Service Parameters ...................................................... 47 5.0.3 Geocode Service Example ......................................................... 47 September 2010 ii GeoServices REST Specification Version 1.0 J-9948 Contents Page 5.0.4 Find Address Candidates Operation .......................................... 48 5.0.4.1 Find Address Candidates Reference ................................. 48 5.0.4.2 Find Address Candidates Parameters................................ 48 5.0.4.3 Find Address Candidates Example ................................... 49 5.0.5 Reverse Geocode Operation ...................................................... 50 5.0.5.1 Reverse Geocode Reference ............................................. 50 5.0.5.2 Reverse Geocode Parameters ............................................ 50 5.0.5.3 Reverse Geocode Example ............................................... 51 6.0 GP Service .......................................................................................... 52 6.0.1 GP Service Reference ................................................................ 52 6.0.2 GP Service Parameters ............................................................... 53 6.0.3 GP Service Example .................................................................. 53 6.1 Task ............................................................................................... 53 6.1.1 Task Reference ..................................................................... 54 6.1.2 Task Parameters ................................................................... 54 6.1.3 Task Example......................................................................