#Groups Endpoint

You can list, create, modify, delete the groups on your account. You can also add or remove members to them.

#Create a Group

POST https://api.corvusgps.com/v2/groups/

{
    "name": "ACME Industries - Field Forces",
}

{
    "success": "Group has been created successfully!",
    "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [],
            "groupViewers": []
        }
    },
    "id": 1,
    "resultCount": 1
}

#Modify a value:

PATCH https://api.corvusgps.com/v2/groups/1

{
    "name": "Friends"
}

{
    "success": "Group has been modified successfully!",
    "result": {
        "1": {
            "gid": 1,
            "name": "Friends",
            "groupMembers": [],
            "groupViewers": []
        }
    },
    "resultCount": 1
}

#List all of your Groups

GET https://api.corvusgps.com/v2/groups/

{
    "success": "Groups has been retrieved successfully!",
    "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [
                1,
                2,
                3
            ],
            "groupViewers": [
                4,
                5,
                6
            ]
        }
    },
    "resultCount": 1
}

#List a specific Group

GET https://api.corvusgps.com/v2/groups/1

{
    "success": "Group has been retrieved successfully!",
    "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [],
            "groupViewers": []
        }
    },
    "resultCount": 1
}

#Add members to a group

PUT https://api.corvusgps.com/v2/groups/1/groupMembers/1,2,3

{
    "success": "Group Memberships have been modified successfully!",
    "result": {
        "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [
                1,
                2,
                3
            ],
            "groupViewers": []
        }

    },
    "resultCount": 1
}

#Remove members from a group

DELETE https://api.corvusgps.com/v2/groups/1/groupMembers/1

{
    "success": "Group Memberships have been modified successfully!",
    "result": {
        "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [
                2,
                3
            ],
            "groupViewers": []
        }

    },
    "resultCount": 1
}

#Add a viewer to a group

PUT https://api.corvusgps.com/v2/groups/1/groupViewers/1,2,3

{
    "success": "Group Memberships have been modified successfully!",
    "result": {
        "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [
                2,
                3
            ],
            "groupViewers": [
                1,
                2,
                3
            ]
        }

    },
    "resultCount": 1
}

#Remove a viewer from a group

DELETE https://api.corvusgps.com/v2/groups/1/groupViewers/1

{
    "success": "Group Memberships have been modified successfully!",
    "result": {
        "result": {
        "1": {
            "gid": 1,
            "name": "ACME Industries - Field Forces",
            "groupMembers": [
                2,
                3
            ],
            "groupViewers": [
                2,
                3
            ]
        }

    },
    "resultCount": 1
}

#Delete a Group

DELETE https://api.corvusgps.com/v2/groups/1

{
    "success": "Group has been deleted successfully!"
}