GET User Full Sync

Returns a list userExtended objects only for users that have changed within the date range.

Request URL

https://{school}.myschoolapp.com/api/user/UserFullSync?t={token}[&baseRoleId][&marker]

Parameters

baseRoleId stringThe comma separated list of baseRoleId's (e.g. 14,16,22,23

Note: All users with a relationship (ex. son, daughter, spouse) to users matching the inputted baseRoleID parameter will be returned in the response.

markerintThe first call will not use the marker. For subsequent calls, the marker will be the last userID returned. Results are paged at 1000 record, so to get the next set of 1000 you pass the marker back to get the next batch.

Base Role Id's

Student 14
Parent 16
Incoming Student 22
Parent of Incoming Student 23

Response 200

Returned when the operation succeeds.


{
    "TotalRecords": 719,
    "Marker": 0,
    "Users": [
        {
            "OccupationList": [],
            "AddressList": [
                {
                    "address_type": "Home",
                    "shared_ind": false,
                    "AddressId": 1389952,
                    "AddressLine1": "2000 Daniel Island Drive",
                    "AddressLine2": "",
                    "AddressLine3": "",
                    "City": "Charleston",
                    "StateShort": "SC",
                    "ZipCode": "29492",
                    "Country": "United States",
                    "Region": "",
                    "BoardingOrHome": "",
                    "Province": "",
                    "IsMailingAddress": false,
                    "LabelSalutation": "",
                    "FormalSalutation": "",
                    "HouseholdSalutation": "",
                    "IsPrimary": true,
                    "UserId": 1569066,
                    "TypeId": 1005,
                    "AddressTypeLink": []
                }
            ],
            "RelationshipList": [
                {
                    "UserId": 1569066,
                    "RelatedUserVendorId": "",
                    "Firstname": "Alexatest",
                    "Lastname": "Burks min",
                    "Nickname": "",
                    "PrimaryInd": false,
                    "ResidesWith": false,
                    "NoContact": false,
                    "DeleteInd": false,
                    "ShowParent": false,
                    "User1RoleName": "Parent",
                    "User2RoleName": "Child",
                    "RelationshipTypeId": 1,
                    "Relationship": 0,
                    "RelationshipId": 6,
                    "ParentAccess": true,
                    "User1Id": 1569066,
                    "User2Id": 2890836
                },
                {
                    "UserId": 1569066,
                    "RelatedUserVendorId": "",
                    "Firstname": "Scott",
                    "Lastname": "Burks",
                    "Nickname": "",
                    "PrimaryInd": false,
                    "ResidesWith": false,
                    "NoContact": false,
                    "DeleteInd": false,
                    "ShowParent": false,
                    "User1RoleName": "Parent",
                    "User2RoleName": "Child",
                    "RelationshipTypeId": 1,
                    "Relationship": 0,
                    "RelationshipId": 6,
                    "ParentAccess": true,
                    "User1Id": 1569066,
                    "User2Id": 3293351
                }
            ],
            "EducationList": [],
            "PhoneList": [
                {
                    "PhoneId": 1372678,
                    "PhoneNumber": "377-333-7757",
                    "Type": "Home",
                    "TypeId": 1712,
                    "PhoneTypeLink": [],
                    "PhoneIndexId": 365518
                },
                {
                    "PhoneId": 2411842,
                    "PhoneNumber": "377-337-3333",
                    "Type": "Home 2",
                    "TypeId": 2614,
                    "PhoneTypeLink": [],
                    "PhoneIndexId": 1396283
                }
            ],
            "RoleList": [
                {
                    "UserId": 1569066,
                    "ModifyDate": "4/10/2006 2:57 PM",
                    "RoleId": 4180,
                    "RoleName": "All School",
                    "BaseRoleId": 1,
                    "IsEnabled": false,
                    "PersonaId": 0,
                    "PersonaType": 0,
                    "enabled_ind": true,
                    "base_role_ind": false,
                    "Hide": 0
                },
                {
                    "UserId": 1569066,
                    "ModifyDate": "4/10/2006 2:57 PM",
                    "RoleId": 4181,
                    "RoleName": "Platform Manager",
                    "BaseRoleId": 2,
                    "IsEnabled": false,
                    "PersonaId": 0,
                    "PersonaType": 0,
                    "enabled_ind": true,
                    "base_role_ind": false,
                    "Hide": 0
                },
                ...
            ],
            "Religion": "",
            "Ethnicity": "",
            "ProfileUrl": "https://100157.myschooltraining.com/app#profile/1569066/contactcard",
            "AuditDate": "1/20/2017 1:43 PM",
            "EnrollDate": null,
            "DepartDate": null,
            "LastSyncDate": null,
            "RowNumber": 0,
            "RowTotal": 0,
            "UserId": 1569066,
            "FirstName": "Thomas",
            "LastName": "Burks",
            "Email": "ThomasBurks@blackbaud.com",
            "UserName": "burks",
            "HostId": "",
            "Greeting": "",
            "MaidenName": "",
            "NickName": "",
            "Prefix": "",
            "Suffix": "",
            "MiddleName": "",
            "EmailIsBad": false,
            "RetireDate": null,
            "OtherLastName": "Jones",
            "CcEmail": "",
            "CcEmailIsBad": false,
            "Affiliation": "",
            "StudentDisplay": "Burks, Thomas",
            "StudentInfo": {
                "GradYear": "",
                "GradeLevel": "",
                "GradeLevelDescription": ""
            },
            "Citizenship": "",
            "PersonalWebsite": "",
            "BoardingOrDay": "",
            "IsDeceased": false,
            "DeceasedDate": null,
            "LivingStatus": "Married",
            "ScreenName": "",
            "IMService": "",
            "IsLost": false,
            "Gender": "M",
            "BirthDate": "6/17/1979 12:00 AM",
            "PersonalBio": "",
            "MiscBio": "",
            "ResidentFromDate": null,
            "VisaIssueDate": null,
            "VisaExpireDate": null,
            "PassportExpireDate": null,
            "PublishUserPage": true,
            "GradebookDefaultInd": true,
            "CustomField1": "",
            "CustomField2": "",
            "CustomField3": "",
            "CustomField4": "",
            "CustomField5": "",
            "CustomField6": "",
            "CustomField7": "",
            "CustomField8": "",
            "CustomField9": "",
            "CustomField10": "",
            "InsertDate": "4/10/2006 2:57 PM",
            "LastModifyDate": "1/20/2017 1:43 PM",
            "LastModifyUserId": 1801001
        },
        ...
        ]
}

Properties

RelationshipId integer
RelationTypeId integer
User1ID integer
User2ID integer
ListasParent boolean
ParentalAccess boolean