iDigBio

IDigBio API v1 Specification: Difference between revisions

Page Discussion

IDigBio API v1 Specification (view source)

Revision as of 16:44, 20 May 2014

7,658 bytes added ,  20 May 2014
add publisher usage
(add publisher usage)
Line 597: Line 597:
|-
|-
|version
|version
|Numeric values from 0 to maximum version of a particular record
|Numeric values from 0 to maxium version of a particular record
|Specimen Records may be updated over time (changes submitted by data publishers). The "version" parameter is used to retrieve a previous version of a record. A value of "-1" returns the most recent version of a record. Omitting the "version" parameter returns the most recent version of a record.
|Specimen Records may be updated over time (changes submitted by data publishers). The "version" parameter is used to retrieve a previous version of a record. A value of "-1" returns the most recent version of a record. Omitting the "version" parameter returns the most recent version of a record.
|}
|}
Line 648: Line 648:
----
----


=== GET /v1/organizations ===
;Description
:Deprecated, do not use.
----
=== GET /v1/people ===
;Description:
:Deprecated, do not use.
----
=== GET /v1/publishers ===
=== GET /v1/publishers ===


Line 705: Line 718:
----
----


=== GET /v1/organizations ===
;Description
:Deprecated, do not use.
----
=== GET /v1/people ===
;Description:
:Deprecated, do not use.
----
=== GET /v1/publishers/{ID} ===
=== GET /v1/publishers/{ID} ===


;Description
;Description
:Returns a publisher with specific entity ID
:Returns a full publisher record that matches the specified iDigBio UUID. A publisher record includes links to all of the recordsets provided to iDigBio by the publisher.


;Resource URL
;Resource URL
Line 730: Line 731:
;Optional Parameters
;Optional Parameters


* something goes here
{| class="wikitable" style="background-color: #ffffcc;" width="100%"
!parameter
!valid values
!detailed description
|-
|version
|Numeric values from 0 to maximum version of a particular record
|Publisher records may be updated over time. The "version" parameter is used to retrieve a previous version of a record. A value of "-1" returns the most recent version of a record. Omitting the "version" parameter returns the most recent version of a record.
|}


;Sample Usage
;Sample Usage


<pre>
<pre>
# CURL SOMETHING
$ curl -s http://api.idigbio.org/v1/publishers/a9dfa037-425b-442b-8974-94487c29114e | json_pp
{
  "idigbio:uuid" : "a9dfa037-425b-442b-8974-94487c29114e",
  "idigbio:etag" : "e436abe5ac4015449f885f74443abd48cc2ff7f4",
  "idigbio:links" : {
      "recordset" : [
        "http://api.idigbio.org/v1/recordsets/40250f4d-7aa6-4fcc-ac38-2868fa4846bd",
        "http://api.idigbio.org/v1/recordsets/b531ea59-025d-4c29-9d23-99ae75bcd55f",
        "http://api.idigbio.org/v1/recordsets/c569e530-7322-40b8-9b66-1e0ed96fefcb"
      ]
  },
  "idigbio:version" : 9,
  "idigbio:createdBy" : "872733a2-67a3-4c54-aa76-862735a5f334",
  "idigbio:recordIds" : [
      "http://swbiodiversity.org/seinet/webservices/dwc/rss.xml",
      "http://swbiodiversity.org/seinet/"
  ],
  "idigbio:dateModified" : "2014-04-18T15:15:19.172Z",
  "idigbio:data" : {
      "auto_publish" : false,
      "rss_url" : "http://swbiodiversity.org/seinet/webservices/dwc/rss.xml",
      "publisher_type" : "symbiota",
      "base_url" : "http://swbiodiversity.org/seinet/",
      "name" : "SEINet Darwin Core Archive rss feed",
      "recordsets" : {
        "http://swbiodiversity.org/seinet/webservices/dwc/17a53c97-835b-409e-8a9a-c9a7307a4965" : {
            "link" : "http://swbiodiversity.org/seinet/collections/datasets/dwc/ASC_DwC-A.zip",
            "contacts" : [
              {
                  "email" : "seinetadmin@asu.edu",
                  "first_name" : "Edward Gilbert"
              },
              {
                  "email" : "tina.ayers@nau.edu & deaver.herbarium@nau.edu",
                  "first_name" : "Tina Ayers"
              }
            ],
            "ingest" : true,
            "collection_description" : "Number of Specimens: 105 000 Specialty: Colorado Plateau, especially northern Arizona; northeastern Mojave Desert; northern Arizona National Parks and Monuments; vascular plants of the San Francisco Peaks and Coconino National Forest. Important Collections: M. Baker; R. E. Collom; C. F. Deaver; D. Demaree; R. K. Gierisch; L. N. Goodding; G. Goodwin; H. D. Hammond; R. H. Hevly; M. E. Jones; T. H. Kearney; Max Licher; E. L. Little, Jr.; V. O. Mayes; A. M. Phillips; G. R. Rink; C. G. Schaack; J. J. Thornber; A. F. Whiting Incorporated Herbaria: FSLF (1000 specimens) in 1989. Notes: Name for Arizona State College changed to Northern Arizona University in 1966. ASC fungi transferred to MICH in 1998. ASC is temporarily housing NAVA, until the Navajo Natural Heritage builds a new building. Date Founded: 1930. Number of Specimens: 105 000 Specialty: Colorado Plateau, especially northern Arizona; northeastern Mojave Desert; northern Arizona National Parks and Monuments; vascular plants of the San Francisco Peaks and Coconino National Forest. Important Collections: M. Baker; R. E. Collom; C. F. Deaver; D. Demaree; R. K. Gierisch; L. N. Goodding; G. Goodwin; H. D. Hammond; R. H. Hevly; M. E. Jones; T. H. Kearney; Max Licher; E. L. Little, Jr.; V. O. Mayes; A. M. Phillips; G. R. Rink; C. G. Schaack; J. J. Thornber; A. F. Whiting Incorporated Herbaria: FSLF (1000 specimens) in 1989. Notes: Name for Arizona State College changed to Northern Arizona University in 1966. ASC fungi transferred to MICH in 1998. ASC is temporarily housing NAVA, until the Navajo Natural Heritage builds a new building. Date Founded: 1930.",
            "logo_url" : "http://swbiodiversity.org/seinet/images/collicons/nauplant.jpg",
            "collection_name" : "Deaver Herbarium (Northern Arizona University)",
            "institution_web_address" : "http://nau.edu/Merriam-Powell/Biodiversity-Center/Deaver-Herbarium/",
            "id" : "http://swbiodiversity.org/seinet/webservices/dwc/17a53c97-835b-409e-8a9a-c9a7307a4965",
            "other_guids" : [],
            "update" : "2014-04-15T01:00:00"
        },
        "http://swbiodiversity.org/seinet/webservices/dwc/a2e32c87-d320-4a01-bafd-a9182ae2e191" : {
            "link" : "http://swbiodiversity.org/seinet/collections/datasets/dwc/ASU-Plants_DwC-A.zip",
            "contacts" : [
              {
                  "email" : "seinetadmin@asu.edu",
                  "first_name" : "Edward Gilbert"
              },
              {
                  "email" : "les.landrum@asu.edu",
                  "first_name" : "Leslie Landrum"
              }
            ],
            "ingest" : true,
            "collection_description" : "The Arizona State University Vascular Plant Herbarium is the second largest in the Arid Southwest with over 285,000 specimens. Our collection of Cactaceae is one of the best in the world, being particularly rich in cytological vouchers. The Arizona State University Vascular Plant Herbarium is the second largest in the Arid Southwest with over 285,000 specimens. Our collection of Cactaceae is one of the best in the world, being particularly rich in cytological vouchers.",
            "logo_url" : "http://swbiodiversity.org/seinet/images/collicons/asu.jpg",
            "collection_name" : "Arizona State University Vascular Plant Herbarium",
            "institution_web_address" : "http://lifesciences.asu.edu/herbarium/",
            "id" : "http://swbiodiversity.org/seinet/webservices/dwc/a2e32c87-d320-4a01-bafd-a9182ae2e191",
            "other_guids" : [],
            "update" : "2014-04-15T01:00:00"
        },
        "http://swbiodiversity.org/seinet/webservices/dwc/edb9860c-c481-4d19-88cc-224a536ebcd4" : {
            "link" : "http://swbiodiversity.org/seinet/collections/datasets/dwc/DES_DwC-A.zip",
            "contacts" : [
              {
                  "email" : "seinetadmin@asu.edu",
                  "first_name" : "Edward Gilbert"
              },
              {
                  "email" : "asalywon@dbg.org",
                  "first_name" : "Andrew Salywon"
              }
            ],
            "ingest" : true,
            "collection_description" : "Approximately 75000 specimens in collection, with emphasis on plants of the Southwest and northern Mexico, Cactaceae and Agavaceae. &lt;div style=&quot;margin-top:10px&quot;&gt;&lt;b&gt;Curator:&lt;/b&gt; Wendy C. Hodgson (whodgson&lt;at&gt;dbg.org) &lt;/div&gt; &lt;div style=&quot;margin-top:10px&quot;&gt;&lt;b&gt;Assistant Curator:&lt;/b&gt; Andrew Salywon &lt;/div&gt; Approximately 75000 specimens in collection, with emphasis on plants of the Southwest and northern Mexico, Cactaceae and Agavaceae. &lt;div style=&quot;margin-top:10px&quot;&gt;&lt;b&gt;Curator:&lt;/b&gt; Wendy C. Hodgson (whodgson&lt;at&gt;dbg.org) &lt;/div&gt; &lt;div style=&quot;margin-top:10px&quot;&gt;&lt;b&gt;Assistant Curator:&lt;/b&gt; Andrew Salywon &lt;/div&gt;",
            "logo_url" : "http://swbiodiversity.org/seinet/images/collicons/des.jpg",
            "collection_name" : "Desert Botanical Garden Herbarium Collection",
            "institution_web_address" : "http://www.dbg.org/",
            "id" : "http://swbiodiversity.org/seinet/webservices/dwc/edb9860c-c481-4d19-88cc-224a536ebcd4",
            "other_guids" : [],
            "update" : "2014-04-15T01:00:00"
        }
      }
  }
}
 
</pre>
</pre>


Dstoner
1,554

edits

Retrieved from "http://www.idigbio.org/wiki/index.php/Special:MobileDiff/10016"