Contributor Profile

pkarman edited this page Sep 4, 2014 · 16 revisions

Summary

The Contributor Profile extends the PMP Core Profile. The intention of the Contributor Profile is to describe an instance of a content contributor: an author, organization or other entity.

Contributor Profile Definition

Canonical URL: https://api.pmp.io/profiles/contributor

{
  "version" : "1.0"
, "attributes" : {  
    "guid"        : "8bf6f5ae-84b1-4e52-a744-8e1ac63f283e"
  , "title"       : "Contributor Profile"
  , "valid"       : { "from" : "2014-03-11T13:21:31.598Z"
                    , "to"   : "3014-03-11T13:21:31.598Z"}
  }
, "items" : []      
, "links" : {
    "profile"      : [ { "href" : "https://api.pmp.io/profiles/profile"
                       , "type" : "application/vnd.pmp.collection.doc+json" }]
  , "extends"      : [ { "href" : "https://api.pmp.io/profiles/pmpcore"
                       , "type" : "application/vnd.pmp.collection.doc+json" }]
  , "self"         : [ { "href" : "https://api.pmp.io/docs/8bf6f5ae-84b1-4e52-a744-8e1ac63f283e"
                       , "type" : "application/vnd.pmp.collection.doc+json" }]
  , "documentation": [ { "href" : "http://docs.pmp.io/wiki/Contributor-Profile"
                       , "type" : "text/html"}]
  , "schema"       : [ { "href"  : "https://api.pmp.io/schemas/contributor"
                       , "scope" : "update", "type" : "application/schema+json"}]
  , "alternate"    : [ { "href" : "https://api.pmp.io/profiles/contributor" }]
  , "edit-form"    : [ { "href" : "https://api.pmp.io/docs-validator", "type" :   "application/json"}]
  }
}

Fields

In addition to the fields defined in the PMP Core Profile, Contributor defines these fields:

  • firstName: optional.
  • lastName: optional.
  • middleName: optional.
  • bio: optional.
  • org: optional.
  • orgTitle: optional.
  • phone: optional.

Collection URN

Documents that refer to a document instance of the Contributor profile should use the URN urn:collectiondoc:collection:contributor.

Sample Contributor Document

{
  "version" : "1.0"
, "attributes": {
    "valid": {
      "from": "2014-03-11T12:17:15+00:00",
      "to": "3014-03-11T12:17:15+00:00"
    }
  , "created": "2014-03-11T17:16:39+00:00"
  , "modified": "2014-03-11T17:16:39+00:00"
  , "org": "Marketplace"
  , "description": "Kai Ryssdal is the host and senior editor of Marketplace, public radio’s program on business and the economy."
  , "hreflang": "en"
  , "tags": [
      "Money",
      "Technology"
    ]
  , "lastName": "Ryssdal"
  , "firstName": "Kai"
  , "orgTitle": "Host, Marketplace"
  , "published": "2014-03-11T12:17:15+00:00"
  , "title": "Ryssdal, Kai"
  , "guid": "44244c1e-be41-41c3-616d-d08d57ff889e"
  , "bio": "Kai Ryssdal has been the host and senior editor of <em>Marketplace,</em> public radio’s program on business and the economy, since 2005."
  }
, "links": {
    "profile": [
    {
      "href": "https://api.pmp.io/profiles/contributor",
      "title": "Contributor"
    }
  ]
  , "copyright": [
    {
      "href": "http://www.publicradio.org/terms",
      "title": "Copyright (C) 2014 American Public Media Group"
    }
  ]
  , "item": [
    {
      "href": "https://api-sandbox.pmp.io/docs/04b11b80-1d62-1437-056a-c16f98c4b2fb",
      "title": "Ryssdal, Kai",
      "type": "image/jpeg"
    }
  , {
      "href": "https://twitter.com/kairyssdal",
      "title": "Twitter",
      "type": "text/html"
    }
  ]
  , "alternate": [
    {
      "href": "http://www.marketplace.org/people/kai-ryssdal",
      "type": "text/html"
    }
  ]
}