GET User Extended

Get additional User information.

Request URL

https://{school}.myschoolapp.com/api/user/extended/[userId]?t={token}

Parameters

Parameter	Required	Type	Description
userId		int	The ID of the user to return record entries for. The `UserID` is returned in the GET Users call.

Response 200

Returned when the operation succeeds.

JSON

&#123;
    "AddressList": [
        &#123;
            "address_type": "Home",
            "shared_ind": true,
            "AddressId": 2128813,
            "AddressLine1": "5755 Hockey Way",
            "AddressLine2": "",
            "AddressLine3": "",
            "City": "Portsmouth",
            "StateShort": "NH",
            "ZipCode": "03661",
            "Country": "United States",
            "Region": "",
            "BoardingOrHome": "",
            "Province": "",
            "IsMailingAddress": true,
            "LabelSalutation": "",
            "FormalSalutation": "",
            "HouseholdSalutation": "",
            "LastModifyDate": null,
            "IsPrimary": true,
            "UserId": 2884690,
            "TypeId": 1005,
            "AddressTypeLink": [],
            "InsertDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        }
    ],
    "RoleList": [
        &#123;
            "RoleId": 4180,
            "RoleName": "All School",
            "BaseRoleId": 1,
            "BaseRoleName": "All School",
            "IsEnabled": false,
            "PersonaDesc": null,
            "PersonaId": 0,
            "PersonaType": 0,
            "enabled_ind": false,
            "base_role_ind": true,
            "Hide": 0,
            "InsertDate": null,
            "LastModifyDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        },
        &#123;
            "RoleId": 4184,
            "RoleName": "Student",
            "BaseRoleId": 14,
            "BaseRoleName": "Student",
            "IsEnabled": false,
            "PersonaDesc": null,
            "PersonaId": 0,
            "PersonaType": 0,
            "enabled_ind": false,
            "base_role_ind": true,
            "Hide": 0,
            "InsertDate": null,
            "LastModifyDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        },
        &#123;
            "RoleId": 4211,
            "RoleName": "Class Agent",
            "BaseRoleId": 39,
            "BaseRoleName": "Class Agent",
            "IsEnabled": false,
            "PersonaDesc": null,
            "PersonaId": 0,
            "PersonaType": 0,
            "enabled_ind": false,
            "base_role_ind": true,
            "Hide": 0,
            "InsertDate": null,
            "LastModifyDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        }
    ],
    "PhoneList": [
        &#123;
            "PhoneId": 2180429,
            "PhoneNumber": "775-535-5573",
            "Type": "Home",
            "TypeId": 1712,
            "InsertedBy": null,
            "ModifiedBy": null,
            "LastModifyDate": null,
            "PhoneTypeLink": [
                &#123;
                    "TypeId": 1712,
                    "Type": "Home",
                    "PhoneId": null,
                    "UserId": 2884690,
                    "Shared": false,
                    "SharedUser": null,
                    "SharedRelationShip": null,
                    "InsertDate": null,
                    "LastModifyDate": null,
                    "LastModifyUserId": null,
                    "vendor_external_id": null
                },
                &#123;
                    "TypeId": 1712,
                    "Type": "Home",
                    "PhoneId": null,
                    "UserId": 2884691,
                    "Shared": true,
                    "SharedUser": "Mary  Bailes",
                    "SharedRelationShip": "Parent",
                    "InsertDate": null,
                    "LastModifyDate": null,
                    "LastModifyUserId": null,
                    "vendor_external_id": null
                }
            ],
            "PhoneIndexId": 1082384,
            "InsertDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        }
    ],
    "OccupationList": [],
    "EducationList": [],
    "Relationships": [
        &#123;
            "Firstname": "Mary ",
            "Lastname": "Bailes",
            "Nickname": "",
            "PrimaryInd": false,
            "ResidesWith": false,
            "NoContact": false,
            "Comment": null,
            "DeleteInd": false,
            "ShowParent": false,
            "HasSharedAddressOrPhone": null,
            "User1RoleName": "Parent",
            "User2RoleName": null,
            "RelationshipTypeId": null,
            "Relationship": 0,
            "RelationshipId": 6,
            "ParentAccess": true,
            "ListAsParent": null,
            "TuitionResponsibleSigner": null,
            "User1Id": 2884691,
            "User2Id": 2884690,
            "InsertDate": null,
            "LastModifyDate": null,
            "LastModifyUserId": null,
            "vendor_external_id": null
        }
    ],
    "RowNumber": 0,
    "RowTotal": 0,
    "UserId": 2884690,
    "FirstName": "Marc",
    "LastName": "Bailes",
    "Email": "MarcBailes@gmail.com",
    "UserName": "",
    "HostId": "",
    "Greeting": "",
    "MaidenName": "",
    "NickName": "",
    "Prefix": "",
    "Suffix": "",
    "MiddleName": "",
    "Ssn": null,
    "EmailIsBad": false,
    "RetireDate": null,
    "OtherLastName": "Sevard",
    "CcEmail": "",
    "CcEmailIsBad": false,
    "ReligionTypeId": null,
    "Affiliation": "",
    "StudentDisplay": "Bailes, Marc &apos;16",
    "DisplayName": null,
    "StudentInfo": &#123;
        "GradYear": "2016",
        "GradeLevel": null,
        "GradeLevelDescription": null
    },
    "EthnicityType": null,
    "Citizenship": "",
    "PersonalWebsite": "",
    "BoardingOrDay": "",
    "IsDeceased": false,
    "DeceasedDate": null,
    "LivingStatus": "",
    "IsAbroad": null,
    "ScreenName": "",
    "IMService": "",
    "IsLost": false,
    "Gender": "M",
    "BirthDate": "2/9/2004 12:00 AM",
    "PersonalBio": "",
    "MiscBio": "",
    "Note": null,
    "CitizenshipId": null,
    "LatinoHispanic": null,
    "InStateResident": null,
    "ResidentCounty": "",
    "ResidentFromDate": null,
    "BirthPlace": "",
    "PrimaryLanguageId": null,
    "SpokenLanguages": [
        &#123;
            "UserLanguageId": 0,
            "LanguageId": 0,
            "LanguageDesc": null,
            "InsertDate": "10/14/2010 1:14 PM",
            "LastModifyDate": null,
            "LastModifyUserId": 3296470,
            "vendor_external_id": null
        }
    ],
    "RaceSelections": [
        &#123;
            "UserRaceId": 0,
            "RaceId": 0,
            "RaceDesc": null,
            "InsertDate": "10/14/2010 1:14 PM",
            "LastModifyDate": null,
            "LastModifyUserId": 3296470,
            "vendor_external_id": null
        }
    ],
    "languagesXml": null,
    "racesXml": null,
    "VisaNumber": "",
    "VisaTypeId": null,
    "VisaStatus": null,
    "VisaIssueDate": null,
    "VisaExpireDate": null,
    "PassportNumber": "",
    "PassportExpireDate": null,
    "StudentId": "",
    "LockerNbr": "",
    "LockerCombo": "",
    "MailboxNbr": "",
    "MailboxCombo": "",
    "ParentId": null,
    "PublishUserPage": true,
    "GradebookDefaultInd": true,
    "DefaultPersonaId": null,
    "CustomField1": "",
    "CustomField2": "",
    "CustomField3": "",
    "CustomField4": "",
    "CustomField5": "",
    "CustomField6": "",
    "CustomField7": "",
    "CustomField8": "",
    "CustomField9": "",
    "CustomField10": "",
    "ProfilePhoto": &#123;
        "Id": 1055645,
        "FilePath": null,
        "ThumbFilePath": null,
        "ZoomFilePath": null,
        "OriginalFilePath": null,
        "LargeFilenameUrl": "",
        "LargeFilename": "",
        "LargeHeight": 0,
        "LargeWidth": 0,
        "ThumbFilenameUrl": "",
        "ThumbFilename": "",
        "ThumbWidth": 0,
        "ThumbHeight": 0,
        "ZoomFilenameUrl": "",
        "ZoomWidth": 0,
        "ZoomHeight": 0,
        "OriginalFilenameUrl": "",
        "OriginalFilename": "",
        "OriginalWidth": 0,
        "OriginalHeight": 0,
        "Title": "",
        "Caption": "",
        "LongDescription": "",
        "TagList": [],
        "InsertDate": null,
        "LastModifyDate": null,
        "LastModifyUserId": null,
        "vendor_external_id": null
    },
    "InsertDate": "10/14/2010 1:14 PM",
    "LastModifyDate": null,
    "LastModifyUserId": 3296470,
    "vendor_external_id": null
}

Properties

Name	Description	Type
UserID	Read only	integer
FirstName		string
LastName		string
Email		string
HostId		string
Greeting		string
MaidenName		string
NickName		string
Prefix		string
Suffix		string
MiddleName		string
OtherLastName		string
Affiliation		string
Gender		string
BirthDate		date

Extended Properties

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

Audit Properties

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

Connections

Name	Description	Type
StudentInfo	Basic information about enrollment status.	StudentInfo

Extended Connections

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