Introduction

This API is a sample API that is intended to exercise Enunciate. It has a lot of relatively obscure cases that probably won't be used very much, including:

• one-way methods
• collections as operation parameters
• REST nouns and verbs
• RPC/lit methods
• SOAP headers

This text should be showing up in the index page under the "introduction" section.

REST

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

• /pedigree/person
• /posterdude
• /properties/generic
• /remover/pedigree/person/{id}
• /source
• /source/{id}

There is also a WADL document describing the REST API.

SOAP

This API is exposed through a set of WSI Basic Profile -compliant SOAP v1.1 endpoints. The API supports XML-binary Optimized Pacakging (XOP) and SOAP Message Transmission Optimization Mechanism (MTOM) for transmission of binary data. The SOAP API is fully described by the following endpoints:

• AssertionServiceService
• PersonServiceService
• source-service
• RelationshipServiceService

The SOAP API is also accessible by client-side libraries that can be downloaded from the download page.

Data

All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

Data Schemas

id	namespace	schema file
ns0	Default Namespace	ns0.xsd
full	http://enunciate.codehaus.org/samples/full	full.xsd
cite	http://enunciate.codehaus.org/samples/genealogy/cite	cite.xsd
data	http://enunciate.codehaus.org/samples/genealogy/data	data.xsd

XML Data Elements

• namespace ns0
  • eisFault
• namespace full
  • UnknownSourceException
• namespace cite
  • contributor
  • repository
  • source
• namespace data
  • event
  • person
  • rootElementMapWrapper

XML Data Types

• namespace ns0
  • eisFault
  • unknownSourceBean
• namespace cite
  • contributor
  • EMail
  • infoSet
  • repository
  • source
• namespace data
  • (anonymous)
  • assertion
  • event
  • eventDescriptionContainer
  • eventType
  • fact
  • factType
  • gender
  • genderType
  • name
  • occurringAssertion
  • person
  • relationship
  • rootElementMapAdapted
  • rootElementMapAdaptedEntry
  • rootElementMapAdaptedValue
  • rootElementMapWrapper