Difference between revisions of "Api"

From Wiki

Jump to: navigation, search
(Profile Access: Wikified table.)
(Changed to link to the new documentation)
 
(41 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{TOC right}}
+
Please see http://www.geni.com/platform/developer/help for detailed API documentation.
 
 
= 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 =
 
 
 
{| class="wikitable references-small" border="0" cellpadding="7" cellspacing="0"
 
|-
 
| '''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 =
 
<table>
 
<tr>
 
  <th align='left'>geni.com/api/v1/trees/''&lt;walk&gt;''/''&lt;id&gt;''.''&lt;format&gt;''</th>
 
  <td>walk starting with other profile</td>
 
</tr>
 
</table>
 
 
 
== 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, ...
 
 
 
<table>
 
<tr>
 
  <th align='left'>geni.com/api/v1/media/''&lt;id&gt;''.''&lt;format&gt;''</th>
 
  <td>meta-data for media</td>
 
</tr>
 
<tr>
 
  <th align='left'>geni.com/api/v1/media/tagged.''&lt;format&gt;''?profile_id=''&lt;id&gt;''</th>
 
  <td>meta-data for media tagged with id</td>
 
</tr>
 
<tr>
 
  <th align='left'>geni.com/api/v1/media/photo/''&lt;id&gt;''-''&lt;size&gt;''</th>
 
<td>jpeg photo by id and size</td>
 
</tr>
 
<tr>
 
  <th align='left'>geni.com/api/v1/media/video/''&lt;id&gt;</th>
 
<td>flv video by id</td>
 
</tr>
 
</table>
 
 
 
== Sizes: ==
 
* original.
 
* large.
 
* medium.
 
* small.
 
* t (thumbnail).
 
* t2 (cropped thumbnail).
 
 
 
== Notes ==
 

Latest revision as of 22:29, 29 November 2011

Please see http://www.geni.com/platform/developer/help for detailed API documentation.

Personal tools