People are the users of SkyVault. A person entity describes the user as
they are known to SkyVault. There are API methods to get the sites a person is a
member of, to get the details of a person, their favorite sites, preferences, and networks
they are a member of. Methods are also available to process activities related to a person.
To see documentation for methods on this entity, and to try them out on our online REST API explorer, go to https://api-explorer.alfresco.com/api-explorer/#/people. If you have the REST API explorer running locally, then go to http://localhost:8080/api-explorer#/people.
Person object
| Property | Type | JSON Type | Description |
|---|---|---|---|
| enabled | boolean | boolean | Is this person currently enabled? |
| lastName | string | string | the person's last name |
| location | string | string | The person's location or address |
| avatarId | id | string | The id of the person's avatar |
| instantMessageId | string | string | The person's instant message Id |
| googleId | string | string | The person's Google Id |
| id | email id | string | The person's personId - the email address with which the person registered |
| skypeId | string | string | The person's Skype Id |
| description | string | string | The person's description |
| company | company | object | An embedded company object describing the person's company |
| firstName | string | string | The person's first name |
| telephone | string | string | The person's telephone number |
| jobTitle | string | string | The person's job title |
| mobile | string | string | The person's mobile number |
Example of a person object
{
"entry" : {
"enabled" : true,
"lastName" : "Bloggs",
"location" : "Somewhere",
"avatarId" : "85d45e64-eb02-44e1-b989-dbf571ab0704",
"instantMessageId" : "fredb",
"googleId" : "fredb@gmail.com",
"id" : "fred.bloggs@yourcompany.com",
"skypeId" : "fredb",
"email" : "fred.bloggs@yourcompany.com",
"description" : "Been with company for n years",
"company" : {
"organization" : "Your Company",
"address1" : "Some place",
"address2" : "Somewhere",
"postcode" : "Z99 9Z9",
"telephone" : "01234 123456",
"fax" : "01234 123457",
"email" : "info@yourcompany.com"
},
"firstName" : "Fred",
"telephone" : "01234 567890",
"jobTitle" : "VP of something",
"mobile" : "07777 567890"
}
}