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 int

Response 200

Returned when the operation succeeds.


[
    {
        "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
    }
]

Relationship Id's

1 1 Step-Parent Step-Child
2 1 Great Grandparent Great Grandchild
3 1 Guardian Ward
4 1 Aunt/Uncle Niece/Nephew
5 1 Grandparent Grandchild
6 1 Parent Child
7 1 Consultant/Custodian Custodial Student
8 1 Consultant Consultant Student
9 1 Caretaker Charge
51 2 Spouse/Partner Spouse/Partner
52 2 Step-Sibling Step-Sibling
53 2 Ex-Husband Ex-Wife
54 2 Associate Associate
55 2 Half-Sibling Half-Sibling
56 2 Husband Wife
57 2 Spouse Spouse
58 2 Sibling Sibling
59 2 Cousin Cousin
60 2 Friend Friend