IDigBio API v1 Specification: Difference between revisions

Jump to navigation Jump to search
add publishers uuid recordsets
(cleanup)
(add publishers uuid recordsets)
Line 671: Line 671:


;Description
;Description
: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 as well as other information.
:Returns a full Publisher Record matching the specified iDigBio UUID. A publisher record includes links to all of the recordsets provided to iDigBio by the publisher as well as other information about each recordset.


;Resource URL
;Resource URL
Line 784: Line 784:
       }
       }
   }
   }
}
</pre>
[[#toc|Back to contents]]
----
=== GET /v1/publishers/{UUID}/recordsets ===
;Description
:Return a List of recordset iDigBio UUIDs that are associated with the Publisher of the specified iDigBio UUID (returns a list of recordsets that are published by a particular Publisher).
;Resource URL
<pre>
http://api.idigbio.org/v1/publishers/{UUID}/recordsets
</pre>
;Optional Parameters
{| class="wikitable" style="background-color: #ffffcc;" width="100%"
!parameter
!valid values
!detailed description
|-
|limit
|0, 1, 2, ..., 10, ..., n
|Controls the number of items returned.
|-
|offset
|0, 1, 2, ..., 10, ..., n
|Controls the starting offset for paging through the API.
|}
;Sample Usage
<pre>
$ curl -s http://api.idigbio.org/v1/publishers/d347ee15-f16e-4650-930c-4e54d9ce549e/recordsets | json_pp
{
  "idigbio:errors" : [],
  "idigbio:links" : {},
  "idigbio:items" : [
      {
        "idigbio:links" : {
            "recordset" : "http://api.idigbio.org/v1/recordsets/271a9ce9-c6d3-4b63-a722-cb0adc48863f"
        },
        "idigbio:uuid" : "271a9ce9-c6d3-4b63-a722-cb0adc48863f"
      }
  ],
  "idigbio:itemCount" : "1"
}
}


1,554

edits

Navigation menu