Get additional User information, regardless of publish settings.
https://{school}.myschoolapp.com/api/user/extended/all/userId/?t={token}
Parameter | Required | Type | Description |
---|---|---|---|
userID | Property is required | The ID of the user to return record entries for. The UserID | |
relationship | bool | Enter True if the userID's relationship should be returned. |
The user information with the specified user ID (does not following directory publish security).
Name | Description | Type |
---|---|---|
UserID | Read only | integer |
FirstName | string | |
LastName | string | |
string | ||
HostId | string | |
Greeting | string | |
MaidenName | string | |
NickName | string | |
Prefix | string | |
Suffix | string | |
MiddleName | string | |
OtherLastName | string | |
Affiliation | string | |
Gender | string | |
BirthDate | date |
These fields are returned by /user/extended/(userID)/ in addition to the above field(s).
Name | Description | Type |
---|---|---|
EthnicityType | integer | |
Citizenship | string | |
PersonalWebsite | integer | |
BoardingOrDay | integer | |
IsDeceased | boolean | |
DeceasedDate | date | |
LivingStatus | string | |
IsAbroad | boolean | |
ScreenName | string | |
IMService | string | |
IsLost | boolean | |
CustomField1 - 10 | string |
These fields are returned by /user/audit/.
Name | Description | Type |
---|---|---|
PrimaryKey | integer | |
FieldName | string | |
SourceBefore | string | |
SourceAfter | string | |
ChangeDate | date | |
DeceasedDate | date | |
HandledInd | boolean | |
DownloadedInd | boolean |
Name | Description | Type |
---|---|---|
StudentInfo | Basic information about enrollment status. | StudentInfo |
These connections are returned by /user/extended/(userID)/ in addition to the above connection(s).
Name | Description | Type |
---|---|---|
AddressList | Array of Address | |
PhoneList | Array of Phone | |
OccupationList | Array of Occupation | |
EducationList | Array of Education | |
Relationships | Array of Relationship | |
ProfilePhoto | PhotoItem |