GET restapi/personal/person/v1

Get the user's profile details.

The Language property of the returned type is a Language Code on the form "nb-NO" and "en-GB", where the language part is based on ISO-639-1.

The client of this API may use the user's language to automatically choose localisation for the user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Details about the user like name, profile image URL, language etc.

Itslearning.RestApi.Entities.PersonProfile

Name	Description	Type	Additional information
PersonId	The unique ID of the person	integer	None.
FirstName	The users first name. It can only be used when first name is displayed without last name. Otherwise must be used.	string	None.
LastName	The users last name.	string	None.
Language	The users preferred language.	string	None.
ProfileImageUrl	The absolute URL to the user uploaded profile image.	string	None.
Children	DEPRECATED Use GET restapi/personal/children/v1 to get the list of children	Collection of Itslearning.RestApi.Entities.Child	None.
iCalUrl	The iCal URL to the person's calendar. Calendar feed returns events from all courses.	string	None.
CanAccessMessageSystem	True if user can access the internal messages system	boolean	None.
CanAccessCalendar	True if user can access the itslearning calendar system	boolean	None.
CanAccessPersonalSettings	True if user can access personal settings. Need this in order to change profile picture.	boolean	None.
CanAccessInstantMessageSystem	True if user can access the internal instant messages system	boolean	None.
TimeZoneId	Id of timezone that can be used in .net framework: TimeZoneInfo tzi = TimeZoneInfo.FindSystemTimeZoneById(TimeZoneId).	string	None.
Use12HTimeFormat	True if user uses 12h time format.	boolean	None.
SyncKey	The unique person synchronization identifier. Returned only if API client has access to extended data.	string	None.
CanAccessCourses	True if user can courses.	boolean	None.
iCalFavoriteOnlyUrl	The iCal URL to the person's calendar. Calendar feed returns events only from favourite courses.	string	None.
HasHigherEducationLanguage	If the user should see Higher Education language.	boolean	None.
FullName	The users full name.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PersonId": 1,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Language": "sample string 4",
  "ProfileImageUrl": "sample string 5",
  "Children": [
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4"
    },
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4"
    }
  ],
  "iCalUrl": "sample string 6",
  "CanAccessMessageSystem": true,
  "CanAccessCalendar": true,
  "CanAccessPersonalSettings": true,
  "CanAccessInstantMessageSystem": true,
  "TimeZoneId": "sample string 11",
  "Use12HTimeFormat": true,
  "SyncKey": "sample string 13",
  "CanAccessCourses": true,
  "iCalFavoriteOnlyUrl": "sample string 15",
  "HasHigherEducationLanguage": true,
  "FullName": "sample string 17"
}

application/xml, text/xml

Sample:

<PersonProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>1</PersonId>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Language>sample string 4</Language>
  <ProfileImageUrl>sample string 5</ProfileImageUrl>
  <Children xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
    <d2p1:Child>
      <d2p1:PersonId>1</d2p1:PersonId>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:FullName>sample string 4</d2p1:FullName>
    </d2p1:Child>
    <d2p1:Child>
      <d2p1:PersonId>1</d2p1:PersonId>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:FullName>sample string 4</d2p1:FullName>
    </d2p1:Child>
  </Children>
  <iCalUrl>sample string 6</iCalUrl>
  <CanAccessMessageSystem>true</CanAccessMessageSystem>
  <CanAccessCalendar>true</CanAccessCalendar>
  <CanAccessPersonalSettings>true</CanAccessPersonalSettings>
  <CanAccessInstantMessageSystem>true</CanAccessInstantMessageSystem>
  <TimeZoneId>sample string 11</TimeZoneId>
  <Use12HTimeFormat>true</Use12HTimeFormat>
  <SyncKey>sample string 13</SyncKey>
  <CanAccessCourses>true</CanAccessCourses>
  <iCalFavoriteOnlyUrl>sample string 15</iCalFavoriteOnlyUrl>
  <HasHigherEducationLanguage>true</HasHigherEducationLanguage>
  <FullName>sample string 17</FullName>
</PersonProfile>