Difference between revisions of "Api"

From Wiki

Jump to: navigation, search
m (Updates based on Talk:API and format changes.)
(Wikified all except for the 3 tables.)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
<h1>API Notes</h1>
 
<ul>
 
  <li>OAuth authentication.</li>
 
  <li>Can also make calls using web browser once you're logged in</li>
 
  <li>First pass will be read-only</li>
 
</ul>
 
  
<h1>Global Parameters</h1>
+
= API Notes =
 +
* OAuth authentication.
 +
* Can also make calls using web browser once you're logged in.
 +
* First pass will be read-only.
 +
 
 +
 
 +
= Global Parameters =
 
These parameters can be used in any API call.
 
These parameters can be used in any API call.
  
<h2>Formats:</h2>
+
== Formats: ==
<ul>
+
* json.
  <li>json</li>
+
* ged (GEDCOM 5.5).
  <li>ged (GEDCOM 5.5)</li>
+
* xml (not-GEDCOM 6).
  <li>xml (not-GEDCOM 6)</li>
+
 
</ul>
 
  
<h1>Profile Access</h1>
+
= Profile Access =
 
<table>
 
<table>
 
<tr>
 
<tr>
Line 37: Line 36:
 
</table>
 
</table>
  
<h2>Fields:</h2>
+
== Fields: ==
 
Permission required for some.
 
Permission required for some.
<ul>
+
* First Name.
  <li>First Name</li>
+
* Middle Name.
  <li>Middle Name</li>
+
* Last Name.
  <li>Last Name</li>
+
* Display Name.
  <li>Display Name</li>
+
* Birth Event Id.
  <li>Birth Event Id</li>
+
* Birth Date.
  <li>Birth Date</li>
+
* Birth Location.
  <li>Birth Location</li>
+
* Death Event Id.
  <li>Death Event Id</li>
+
* Death Date.
  <li>Death Date</li>
+
* Death Location.
  <li>Death Location</li>
+
* Residence Event Ids.
  <li>Residence Event Ids</li>
+
* Current Location/Place of Burial.
  <li>Current Location/Place of Burial</li>
+
* Merge profile ids.
  <li>Merge profile ids</li>
+
* TBD (feel free to add desired fields here).
  <li>TBD (feel free to add desired fields here)</li>
 
</ul>
 
  
<h2>Parameters:</h2>
+
== Parameters: ==
 
Permission required for some.
 
Permission required for some.
<ul>
+
* include_events - add full event details (including location) to result.
  <li>include_events - add full event details (including location) to result.</li>
+
* include_merges - add full profile info to result.
  <li>include_merges - add full profile info to result.</li>
 
</ul>
 
 
 
<h3>Notes</h3>
 
  
 +
=== Notes ===
  
<h1>Tree Access</h1>
+
= Tree Access =
 
<table>
 
<table>
 
<tr>
 
<tr>
Line 74: Line 68:
 
</table>
 
</table>
  
<h2>Walks:</h2>
+
== Walks: ==
<ul>
+
* ancestors.
  <li>ancestors</li>
+
* blood_tree.
  <li>blood_tree</li>
+
* descendants.
  <li>descendants</li>
+
* forest.
  <li>forest</li>
+
* immediate_family.
  <li>immediate_family</li>
 
</ul>
 
 
 
 
 
<h2>Fields:</h2>
 
<ul>
 
  <li>Marriage id</li>
 
  <li>Partner ids</li>
 
  <li>Children ids</li>
 
</ul>
 
  
 +
== Fields: ==
 +
* Marriage id.
 +
* Partner ids.
 +
* Children ids.
  
<h3>Notes</h3>
+
=== Notes ===
  
  
<h1>Event Access</h1>
+
= Event Access =
 
TBD
 
TBD
  
<h1>Media Access</h1>
+
= Media Access =
 
Photos, Videos, Documents, Links, ...
 
Photos, Videos, Documents, Links, ...
  
Line 120: Line 108:
 
</table>
 
</table>
  
<h2>Sizes:</h2>
+
== Sizes: ==
<ul>
+
* original.
  <li>original</li>
+
* large.
  <li>large</li>
+
* medium.
  <li>medium</li>
+
* small.
  <li>small</li>
+
* t (thumbnail).
  <li>t (thumbnail)</li>
+
* t2 (cropped thumbnail).
  <li>t2 (cropped thumbnail)</li>
 
</ul>
 
  
<h3>Notes</h3>
+
=== Notes ===

Revision as of 23:34, 6 March 2010


API Notes

  • OAuth authentication.
  • Can also make calls using web browser once you're logged in.
  • First pass will be read-only.


Global Parameters

These parameters can be used in any API call.

Formats:

  • json.
  • ged (GEDCOM 5.5).
  • xml (not-GEDCOM 6).


Profile Access

geni.com/api/v1/profiles/current.<format>?<parameters> current user's profile
geni.com/api/v1/profiles/<id>.<format>?<parameters> profile for given ID
geni.com/api/v1/profiles.<format>?<parameters> your immediate family
geni.com/api/v1/profiles.<format>?ids=<id,id,...>?<parameters> profiles for given IDs (up to 50)

Fields:

Permission required for some.

  • First Name.
  • Middle Name.
  • Last Name.
  • Display Name.
  • Birth Event Id.
  • Birth Date.
  • Birth Location.
  • Death Event Id.
  • Death Date.
  • Death Location.
  • Residence Event Ids.
  • Current Location/Place of Burial.
  • Merge profile ids.
  • TBD (feel free to add desired fields here).

Parameters:

Permission required for some.

  • include_events - add full event details (including location) to result.
  • include_merges - add full profile info to result.

Notes

Tree Access

geni.com/api/v1/trees/<walk>/<id>.<format> walk starting with other profile

Walks:

  • ancestors.
  • blood_tree.
  • descendants.
  • forest.
  • immediate_family.

Fields:

  • Marriage id.
  • Partner ids.
  • Children ids.

Notes

Event Access

TBD

Media Access

Photos, Videos, Documents, Links, ...

geni.com/api/v1/media/<id>.<format> meta-data for media
geni.com/api/v1/media/tagged.<format>?profile_id=<id> meta-data for media tagged with id
geni.com/api/v1/media/photo/<id>-<size> jpeg photo by id and size
geni.com/api/v1/media/video/<id> flv video by id

Sizes:

  • original.
  • large.
  • medium.
  • small.
  • t (thumbnail).
  • t2 (cropped thumbnail).

Notes

Personal tools