GET api/v{version}/Group/GetAllUserGroups
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Group| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
|
| Code | string |
Required |
|
| Label | string |
Required |
|
| TimeCalculation | time interval |
Required |
|
| SchedulerDays | Dictionary of date [key] and Day [value] |
None. |
|
| ServiceFuntions | Collection of ServiceFunction |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"GroupID": 1,
"Code": "sample string 2",
"Label": "sample string 3",
"TimeCalculation": "00:00:00.1234567",
"SchedulerDays": {
"$id": "2",
"2025-12-14T09:43:50.5823475+01:00": {
"$id": "3",
"Hour0": true,
"Hour1": true,
"Hour2": true,
"Hour3": true,
"Hour4": true,
"Hour5": true,
"Hour6": true,
"Hour7": true,
"Hour8": true,
"Hour9": true,
"Hour10": true,
"Hour11": true,
"Hour12": true,
"Hour13": true,
"Hour14": true,
"Hour15": true,
"Hour16": true,
"Hour17": true,
"Hour18": true,
"Hour19": true,
"Hour20": true,
"Hour21": true,
"Hour22": true,
"Hour23": true,
"Hour0_15": true,
"Hour1_15": true,
"Hour2_15": true,
"Hour3_15": true,
"Hour4_15": true,
"Hour5_15": true,
"Hour6_15": true,
"Hour7_15": true,
"Hour8_15": true,
"Hour9_15": true,
"Hour10_15": true,
"Hour11_15": true,
"Hour12_15": true,
"Hour13_15": true,
"Hour14_15": true,
"Hour15_15": true,
"Hour16_15": true,
"Hour17_15": true,
"Hour18_15": true,
"Hour19_15": true,
"Hour20_15": true,
"Hour21_15": true,
"Hour22_15": true,
"Hour23_15": true,
"Hour0_30": true,
"Hour1_30": true,
"Hour2_30": true,
"Hour3_30": true,
"Hour4_30": true,
"Hour5_30": true,
"Hour6_30": true,
"Hour7_30": true,
"Hour8_30": true,
"Hour9_30": true,
"Hour10_30": true,
"Hour11_30": true,
"Hour12_30": true,
"Hour13_30": true,
"Hour14_30": true,
"Hour15_30": true,
"Hour16_30": true,
"Hour17_30": true,
"Hour18_30": true,
"Hour19_30": true,
"Hour20_30": true,
"Hour21_30": true,
"Hour22_30": true,
"Hour23_30": true,
"Hour0_45": true,
"Hour1_45": true,
"Hour2_45": true,
"Hour3_45": true,
"Hour4_45": true,
"Hour5_45": true,
"Hour6_45": true,
"Hour7_45": true,
"Hour8_45": true,
"Hour9_45": true,
"Hour10_45": true,
"Hour11_45": true,
"Hour12_45": true,
"Hour13_45": true,
"Hour14_45": true,
"Hour15_45": true,
"Hour16_45": true,
"Hour17_45": true,
"Hour18_45": true,
"Hour19_45": true,
"Hour20_45": true,
"Hour21_45": true,
"Hour22_45": true,
"Hour23_45": true
}
},
"ServiceFuntions": [
{
"$id": "4",
"ServiceFunctionID": 1,
"Label": "sample string 2",
"NumberNeeded": 3,
"NoOccupancy": "sample string 4",
"OccupancyDays": {
"$id": "5",
"2025-12-14T09:43:50.5823475+01:00": {
"$ref": "3"
}
},
"DayTotals": {
"$id": "6",
"2025-12-14T09:43:50.5823475+01:00": {
"$id": "7",
"Hour0": 1,
"Hour1": 2,
"Hour2": 3,
"Hour3": 4,
"Hour4": 5,
"Hour5": 6,
"Hour6": 7,
"Hour7": 8,
"Hour8": 9,
"Hour9": 10,
"Hour10": 11,
"Hour11": 12,
"Hour12": 13,
"Hour13": 14,
"Hour14": 15,
"Hour15": 16,
"Hour16": 17,
"Hour17": 18,
"Hour18": 19,
"Hour19": 20,
"Hour20": 21,
"Hour21": 22,
"Hour22": 23,
"Hour23": 24,
"Hour0_15": 25,
"Hour1_15": 26,
"Hour2_15": 27,
"Hour3_15": 28,
"Hour4_15": 29,
"Hour5_15": 30,
"Hour6_15": 31,
"Hour7_15": 32,
"Hour8_15": 33,
"Hour9_15": 34,
"Hour10_15": 35,
"Hour11_15": 36,
"Hour12_15": 37,
"Hour13_15": 38,
"Hour14_15": 39,
"Hour15_15": 40,
"Hour16_15": 41,
"Hour17_15": 42,
"Hour18_15": 43,
"Hour19_15": 44,
"Hour20_15": 45,
"Hour21_15": 46,
"Hour22_15": 47,
"Hour23_15": 48,
"Hour0_30": 49,
"Hour1_30": 50,
"Hour2_30": 51,
"Hour3_30": 52,
"Hour4_30": 53,
"Hour5_30": 54,
"Hour6_30": 55,
"Hour7_30": 56,
"Hour8_30": 57,
"Hour9_30": 58,
"Hour10_30": 59,
"Hour11_30": 60,
"Hour12_30": 61,
"Hour13_30": 62,
"Hour14_30": 63,
"Hour15_30": 64,
"Hour16_30": 65,
"Hour17_30": 66,
"Hour18_30": 67,
"Hour19_30": 68,
"Hour20_30": 69,
"Hour21_30": 70,
"Hour22_30": 71,
"Hour23_30": 72,
"Hour0_45": 73,
"Hour1_45": 74,
"Hour2_45": 75,
"Hour3_45": 76,
"Hour4_45": 77,
"Hour5_45": 78,
"Hour6_45": 79,
"Hour7_45": 80,
"Hour8_45": 81,
"Hour9_45": 82,
"Hour10_45": 83,
"Hour11_45": 84,
"Hour12_45": 85,
"Hour13_45": 86,
"Hour14_45": 87,
"Hour15_45": 88,
"Hour16_45": 89,
"Hour17_45": 90,
"Hour18_45": 91,
"Hour19_45": 92,
"Hour20_45": 93,
"Hour21_45": 94,
"Hour22_45": 95,
"Hour23_45": 96
}
},
"Users": [
{
"$id": "8",
"UserID": 1,
"HomeNodeID": 2,
"FullName": "sample string 3",
"LangID": 4,
"NotAvailable": true,
"NotAvailableTimestamp": "2025-12-14T09:43:50.5823475+01:00",
"NotAvailalbeScheduled": true,
"NoOccupancy": true,
"Homescreen": "sample string 9",
"AppNotifications": 64,
"MaxVersionAllowed": 11,
"SoundAlarm": "sample string 12",
"SoundInfo": "sample string 13",
"SoundUnderstaffing": "sample string 14",
"SoundOccupancy": "sample string 15",
"SoundProposal": "sample string 16",
"CriticalAlertsAlarm": true,
"CriticalAlertsInfo": true,
"CriticalAlertsUnderstaffing": true,
"CriticalAlertsOccupancy": true,
"CriticalAlertsProposal": true,
"Geofence": {
"$id": "9",
"Selectable": true,
"Address": "sample string 2",
"Latitude": 1.1,
"Longitude": 1.1,
"Distance": 1
},
"SchedulerDays": {
"$id": "10",
"2025-12-14T09:43:50.5823475+01:00": {
"$ref": "3"
}
},
"ConsignmentAppointments": [
{
"$id": "11",
"ServiceFunctionID": 1,
"Start": "2025-12-14T09:43:50.5823475+01:00",
"Stop": "2025-12-14T09:43:50.5823475+01:00"
},
{
"$ref": "11"
}
]
},
{
"$ref": "8"
}
]
},
{
"$ref": "4"
}
]
},
{
"$ref": "1"
}
]