FamilySearch/gedcomx — pull request #128 by stoicflame (2012-02-07 23:56:22+00:00)
Title: define the search resource

Here's the initial proposal for the definition of the `search` resource.

## Search Resource

The search resource defines the set of entries in the system that are applicable to specific search criteria.

Links to the search resource should be defined using a URI template as defined by the
latest URI template specification draft. Implementations are free to choose which parameters are supported and how to apply them to their
URI space, but the following parameters are reserved for conformance to the GEDCOM X specification and are defined as follows:

variable
description

startIndex
The index of the first search result desired by the search client. See
OpenSearch parameters: startIndex.

count
The number of search results per page desired by the search client. See
OpenSearch parameters: count.

resourceType
The type of the resources to search for. Valid values include "person" to search for conclusion persons and "person-matches" to
search for matches of a person.

name
The full name (given + family) of the person being searched.

givenName
The given name of the person being searched.

familyName
The family name of the person being searched.

gender
The gender of the person being searched. Valid values are "male" and "female".

birthDate
The birth date of the person being searched.

birthPlace
The birth place of the person being searched.

deathDate
The death date of the person being searched.

deathPlace
The death place of the person being searched.

marriageDate
The marriage date of the person being searched.

marriagePlace
The marriage place of the person being searched.

Relation Search Parameters

The following set of standard parameters is defined as the substitution of {relation} with all of the
values "father", "mother", "spouse", and "parent".

{relation}Name

The full name (given + family) of the {relation} of the person being searched.

{relation}GivenName
The given name of the {relation} of the person being searched.

{relation}FamilyName
The family name of the {relation} of the person being searched.

{relation}BirthDate

The birth date of the {relation} of the person being searched.

{relation}BirthPlace
The birth place of the {relation} of the person being searched.

{relation}DeathDate
The death date of the {relation} of the person being searched.

{relation}DeathPlace

The death place of the {relation} of the person being searched.

{relation}MarriageDate
The marriage date of the {relation} of the person being searched.

{relation}MarriagePlace
The marriage place of the {relation} of the person being searched.

## Properties

Name:
Search

Namespace:

http://gedcomx.org/conclusion/v1/

Representation(s):
feed

Subresources:
SearchEntry

## Operations

### GET

Read the results of a search.

#### Status Codes

code
condition

200
Upon a successful read.

204
Upon a successful query with no results.

400
If the query to be processed was unable to be understood by the application.

413

If the application declines to process the query because it would have resulted in too many results.