GET restapi/personal/person/{personId}/v1
Gets basic information about the requested person. The person should be allowed to search for by Esafety rules.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| personId |
Identifier of the person. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Itslearning.RestApi.Entities.PersonSimple| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId |
The unique id for for the person, in scope of a site (itslearning customer). |
integer |
None. |
| FirstName |
The person's first name. It can only be used when first name is displayed without last name. Otherwise must be used. |
string |
None. |
| LastName |
The person's last name. It can only be used when last name is displayed without first name. Otherwise must be used. |
string |
None. |
| FullName |
The person's full name formatted according to regional settings of a site. |
string |
None. |
| ProfileUrl |
The url to view the person's profile in itslearning. |
string |
None. |
| AdditionalInfo |
Additional information about the person. This can be context sensitive. For example when using the rest api method for message recipients search, this field can contain extra information about the person, that helps the user distinguish between persons with identical names. |
string |
None. |
| ProfileImageUrl |
The absolute URL to the person's profile image. This can be null or empty if the person does not have a profile image. |
string |
None. |
| ProfileImageUrlSmall |
The absolute URL to the person's profile image. This can be null or empty if the person does not have a profile image. |
string |
None. |
Response Formats
application/json, text/json
{
"PersonId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"FullName": "sample string 4",
"ProfileUrl": "sample string 5",
"AdditionalInfo": "sample string 6",
"ProfileImageUrl": "sample string 7",
"ProfileImageUrlSmall": "sample string 8"
}
application/xml, text/xml
<PersonSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AdditionalInfo>sample string 6</AdditionalInfo> <FirstName>sample string 2</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 3</LastName> <PersonId>1</PersonId> <ProfileImageUrl>sample string 7</ProfileImageUrl> <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall> <ProfileUrl>sample string 5</ProfileUrl> </PersonSimple>