Person

Example JSON

JSON including important fields and a Person's resources. See the tables below for a list of all fields and resources.

{
  "name" : {
    "formatted" : "Administrator"
  },
  "type" : "person",
  "status" : "My new status",
  "displayName" : "Administrator",
  "jive" : {
    "level" : {
      "name" : "Scout",
      "points" : 582
    },
    "profile" : [ {
      "value" : "Master of puppets",
      "jive_label" : "Title"
    }, {
      "value" : "Support",
      "jive_label" : "Department"
    }, {
      "value" : "ACME Inc.",
      "jive_label" : "Company"
    }, {
      "value" : "09/05/2001",
      "jive_label" : "Hire Date"
    }, {
      "value" : "I was born in Earth.",
      "jive_label" : "Biography"
    }, {
      "value" : "Expert in this and that.",
      "jive_label" : "Expertise"
    } ],
    "username" : "admin",
    "external" : false,
    "visible" : true,
    "enabled" : true,
    "externalContributor" : false,
    "federated" : false
  },
  "emails" : [ {
    "value" : "admin@example.com",
    "type" : "work",
    "jive_label" : "Email",
    "primary" : true
  } ],
  "addresses" : [ {
    "value" : {
      "streetAddress" : "915 SW Stark St",
      "locality" : "Portland",
      "region" : "Oregon",
      "postalCode" : "97205",
      "country" : "USA",
      "formatted" : "915 SW Stark St\nPortland Oregon 97205\nUSA"
    },
    "jive_label" : "Address",
    "primary" : true
  } ],
  "phoneNumbers" : [ {
    "value" : "503.972.6655",
    "jive_label" : "Phone Number",
    "primary" : true
  }, {
    "value" : "503.972.6644",
    "jive_label" : "Mobile Phone Number"
  } ],
  "photos" : [ {
    "value" : "https://example.jiveon.com/api/core/v3/people/1/images/1/data"
  } ],
  "thumbnailUrl" : "https://example.jiveon.com/api/core/v3/people/1/avatar",
  "followerCount" : 0,
  "followingCount" : 4,
  "published" : "2012-05-14T19:12:10.061+0000",
  "updated" : "2012-07-15T19:57:17.009+0000",
  "id" : "1",
  "resources" : {
    "reports" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/@reports",
      "allowed" : [ "GET" ]
    },
    "manager" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/@manager",
      "allowed" : [ "GET" ]
    },
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1",
      "allowed" : [ "PUT", "DELETE", "GET" ]
    },
    "avatar" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/avatar",
      "allowed" : [ "GET" ]
    },
    "blog" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/blog",
      "allowed" : [ "GET" ]
    },
    "colleagues" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/@colleagues",
      "allowed" : [ "GET" ]
    },
    "followers" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/@followers",
      "allowed" : [ "GET" ]
    },
    "following" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/@following",
      "allowed" : [ "GET" ]
    },
    "images" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/images",
      "allowed" : [ "POST", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/people/admin",
      "allowed" : [ "GET" ]
    },
    "streams" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/streams",
      "allowed" : [ "POST", "GET" ]
    },
    "followingIn" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/followingIn",
      "allowed" : [ "GET" ]
    },
    "tasks" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/tasks",
      "allowed" : [ "POST", "GET" ]
    },
    "activity" : {
      "ref" : "https://example.jiveon.com/api/core/v3/people/1/activities",
      "allowed" : [ "GET" ]
    }
  }
}

Get a person's group memberships

Perform a GET request to /members/people/{person_id}. This URL can be obtained from the members resource of a Person. See the resources table below.

curl -u admin:admin "http://example.jiveon.com/api/core/v3/members/people/1234"

Create Person

POST to /people creates a new person. The minimum set of fields you must include are:

 {
   "emails" : [ {
       "value" : "{emailAddress}",
       "jive_label" : "Email"
   } ],
   "jive" : {
       "password" : "{password}",
       "username" : "{username}"
   },
   "name" : {
       "familyName" : "{lastName}",
       "givenName" : "{firstName}"
   }
 }

Update Person Status

PUT to /people/{personID} updates a person. By setting the status field, the person status will get updated and published in the activity stream.

Add Profile Image

This is a two steps operation. First, POST to /profileImages/temporary to upload the image that will be used in the next step. Here we see a curl example:

 curl -i -u some_user -F "file1=@myNewLook.png;type=image/png" https://example.jiveon.com/api/core/v3/profileImages/temporary

Pay attention to the location header in the response since we are going to need it for the next step. The second step consists of a POST to /people/{personID}/images where the location header of the previous response will be sent as an HTML form param named imageURI. Here we can see a curl example:

 curl -i -u admin:admin --data "imageURI=https://example.jiveon.com/api/core/v3/profileImages/temporary/tempImage442646.bin" https://example.jiveon.com/api/core/v3/people/2001/images