FISH Interoperability Toolkit Historic Environment Exchange Protocol (HEEP) (S15)
   Next

FISH Interoperability Toolkit Historic Environment Exchange Protocol (HEEP) (S15)

Forum for Information Standards in Heritage

Version DRAFT 0.0.12

Copyright © 2004 English Heritage

Summary Information

This document describes the FISH Heritage Exchange Protocol and related XML schema designed to query and transmit heritage data between heterogeneous systems.

Note that, as this is draft version, the text and structure of the supporting schemas is very likely to change. Some text has been inserted as temporary comments by the authors: such comments are displayed like this , and will be removed or included in the final document after further discussion.

All section and subsection headings have been numbered. This is visually cumbersome for deeply nested headings ("Stored Precision: Section 8.1.1.2.2.1.2") but has been included to facilitate reference during the draft's consultation period.

This document has been written in DocBook XML 4.3.

FISH logo

Author(s):(see above)
Derivation: (previous version)
Origination Date:20 April 2004
Reviser(s):Tyler Bell
Date of last revision: 22 June 2004
Date Printed:n/a
Version:(see above)
Status:RFC
Summary of Changes:
  • Spatial: coordinate representation now using WTK format
  • General: added 'Intended Audience' section
  • General: added additional normative references
  • General: additional terms to glossary
  • Service: added authentication documentation
Circulation:FISH Technical
Required Action:Comments to FISH Technical Forum
File Name:http://195.74.122.210/~twbell/fish/docs/html/index.html
Approval: (Signature) (none required)

Table of Contents

Preface
1. Submission Contact Point
1.1.
2. Online Reference
1. Introduction
2. Scope
2.1. Operations Overview
2.1.1. GetCap
2.1.2. GetData
2.1.3. GetQuerySummary
3. Conformance
4. Normative References
5. Terms and Definitions
6. Conventions
6.1. Normative Verbs
6.2. Abbreviated Terms
7. Basic Service Elements
7.1. Version Numbering and Negotiation
7.1.1. Version Number Format
7.1.2. Version Changes
7.1.3. Appearance in Requests and Service Metadata
7.1.4. Version Number Negotiation
7.2. General HTTP Request Rules
7.3. General HTTP Response Rules
7.4. Request Format and Rules
7.4.1. HTTP GET
7.5. HTTP POST Request Procedure
7.6. Service Result
7.7. Service Exceptions
7.8. Compression
7.9. Authentication
7.9.1. Service Authentication
7.9.2. Client Authentication
8. Spatial Data
8.1. The Spatial Data Schema
8.1.1. Spatial
8.2. Querying Spatial Data
8.2.1. Overview
8.2.2. Dataset Spatial Capabilities
8.2.3. Service Spatial Capabilities
9. Heritage Exchange Request Format
9.1. GetCap Queries
9.1.1. GetCap Using HTTP GET
9.1.2. GetCap Using HTTP POST
9.2. GetData Queries
9.2.1. FISHXML_Request
9.2.2. sessionID
9.2.3. auth
9.2.4. username
9.2.5. password
9.2.6. charset
9.2.7. schema
9.2.8. request
9.2.9. service
9.2.10. type
9.2.11. dataset
9.2.12. queryset
9.2.13. query
9.2.14. object
9.2.15. operation
9.2.16. parameter
9.2.17. resultset
9.2.18. object
9.2.19. sort
9.2.20. object
9.2.21. start
9.2.22. limit
10. Heritage Exchange Capabilities Format
10.1. Reporting HEEP Service Capabilities
10.1.1. Using FISH_Capabilities XML
11. Heritage Exchange Exceptions Format
11.1. FISHXML_Exceptions
11.1.1. serviceException
11.1.2. userServiceException
11.1.3. adminServiceException
11.1.4. clientServiceException
A. FISH XML Schema (Normative)
A.1. FISH Schema
A.2. Request Schema
A.3. Capabilities Schema
A.4. Exceptions Schema
B. FISH XML Examples (Informative)
B.1. MIDAS Example
B.2. Request Example
B.3. Capabilitites Example
B.4. Exceptions Example
B.5. Spatial Example

List of Examples

8.1. Namedplace Element
8.2. Representations Element
8.3. Reporting Spatial Metadata
8.4. Reporting Available Spatial Operations
9.1. A default request
9.2. Requesting specific capabilities
9.3. Requesting multiple capabilities
9.4. Requesting specific exception format
   Next
   Preface