Skip to main content

persons/{uid}

Gets files related information for all or a subset of the documents in the scope:

  • Document name
  • Locales with status information for deliverable

URL

(GET) /persons/{id}

PARAMETERS

The message body contains a JSON object:

uidUnique Id of person of that we want get informations.



RESULTS

The message body contains a JSON object:

company

A company objects.

person

A person objects

 

The item company has these properties:

id

Company id.

nameThe company name.
addressThe company address.

 

The item person  have these properties:

id

Integer. Person id.

firstnameString. Person firstname.
lastnameString. Person lastname.
codeString. Person code.
roleString. Person role.
phoneString. Person phone.
phoneMobileString. Person phone mobile.
emailString. Person email (null if the person as configured email to private)
emailIsPrivateBoolean. True if the person as configured email to private else False.
isActiveBoolean. if the person is active or not in the platform.
pictureString. Relative url to access of the person picture.
linkString. Url to access of the person page.
profileString. Person profile.
labelsAn array of label object
workActivitiesAn activity object
commentsString: the person comments.

 

The item activity have these properties:

standardNumber of standard task active.
codytNumber of codyt task active.

 

Each item in labels has these properties:

... 
... 

 

EXAMPLES

See this example:

CODE
{
	"company": {
		"id": 1,
		"name": "Wordbee",
		"address": "Wordbee"
	},
	"person": {
		"id": 1,
		"firstname": "Claude",
		"lastname": "Pont",
		"code": "CP",
		"role": null,
		"phone": "",
		"phoneMobile": null,
		"email": "user@provider.com",
		"emailIsPrivate": false,
		"isActive": true,
		"picture": "/api/media/persons/1/icon",
		"link": "http://xxx/a/devel/Company/Account.aspx?x=xxxxxxxxxx",
		"labels": [],
		"profile": "Administrator",
		"workActivity": {
			"standard": 0,
			"codyt": 0
		},
		"comments": "",
		"customFields": [{
				"type": 1,
				"title": "Status",
				"value": null
			}, {
				"type": 2,
				"title": "Hobby",
				"value": null
			}, {
				"type": 5,
				"title": "Checkbox",
				"value": null
			}
		]
	}
}

 

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.