GET Relationships

Return a list of relationship settings for a user.

Request URL

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

Parameters

UserId intThe ID of the user to return relationship entries for. The UserID is returned in the GET Users call.

Response 200

Returned when the operation succeeds.

When calling this endpoint for Parent/Child Relationships, User1Id will be the Parent while the User2Id will be the Child.

When looking at Peer Relationships, User1Id will be the primary user of the pair. In the UI, the relationship would be created by navigating to the contact card for the primary user and clicking Add Relationship and adding the secondary user. Peer Relationships can be added in either order, so the order of the IDs in User1Id and User2Id will vary.


[
    {
        "Firstname": "Mark",
        "Lastname": "Anderson",
        "Nickname": null,
        "PrimaryInd": false,
        "ResidesWith": true,
        "NoContact": false,
        "Comment": "",
        "DeleteInd": false,
        "ShowParent": true,
        "HasSharedAddressOrPhone": true,
        "User1RoleName": "Parent",
        "User2RoleName": null,
        "RelationshipTypeId": 1,
        "Relationship": 0,
        "RelationshipId": 6,
        "ParentAccess": true,
        "ListAsParent": true,
        "TuitionResponsibleSigner": true,
        "User1Id": 3293113,
        "User2Id": 3293229,
        "InsertDate": null,
        "LastModifyDate": null,
        "LastModifyUserId": null,
        "vendor_external_id": null
    },
    {
        "Firstname": "Laurie",
        "Lastname": "Anderson",
        "Nickname": null,
        "PrimaryInd": false,
        "ResidesWith": false,
        "NoContact": false,
        "Comment": "",
        "DeleteInd": false,
        "ShowParent": true,
        "HasSharedAddressOrPhone": true,
        "User1RoleName": "Parent",
        "User2RoleName": null,
        "RelationshipTypeId": 1,
        "Relationship": 0,
        "RelationshipId": 6,
        "ParentAccess": true,
        "ListAsParent": true,
        "TuitionResponsibleSigner": true,
        "User1Id": 3293176,
        "User2Id": 3293229,
        "InsertDate": null,
        "LastModifyDate": null,
        "LastModifyUserId": null,
        "vendor_external_id": null
    },
    {
        "Firstname": "Curtis",
        "Lastname": "Anderson",
        "Nickname": null,
        "PrimaryInd": false,
        "ResidesWith": false,
        "NoContact": false,
        "Comment": "",
        "DeleteInd": false,
        "ShowParent": false,
        "HasSharedAddressOrPhone": true,
        "User1RoleName": "Sibling",
        "User2RoleName": null,
        "RelationshipTypeId": 2,
        "Relationship": 0,
        "RelationshipId": 58,
        "ParentAccess": false,
        "ListAsParent": false,
        "TuitionResponsibleSigner": false,
        "User1Id": 3293229,
        "User2Id": 3293250,
        "InsertDate": null,
        "LastModifyDate": null,
        "LastModifyUserId": null,
        "vendor_external_id": null
    }
]

Parent/Child Relationships

1 Step-Parent Step-Child
2 Great Grandparent Great Grandchild
3 Guardian Ward
4 Aunt/Uncle Niece/Nephew
5 Grandparent Grandchild
6 Parent Child
7 Consultant/Custodian Custodial Student
8 Consultant Consultant Student
9 Caretaker Charge

Peer Relationships

51 Spouse/Partner Spouse/Partner
52 Step-Sibling Step-Sibling
53 Ex-Husband Ex-Wife
54 Associate Associate
55 Half-Sibling Half-Sibling
56 Husband Wife
57 Spouse Spouse
58 Sibling Sibling
59 Cousin Cousin
60 Friend Friend