GET api/Communities

Request Information

URI Parameters

None.
Body Parameters

None.
Response Information

Resource Description

Collection of Community
Name	Type	Additional information
CommunityId	integer	None.
CommunityName	string	None.
Description	string	None.
CommunityUrl	string	None.
SchedulerUrl	string	None.
LogoUrl	string	None.
Patronage	Community	None.
Companies	Collection of Company	None.
TrackingObjectGroup	TrackingObjectGroup	None.
Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "CommunityId": 1,
    "CommunityName": "sample string 2",
    "Description": "sample string 3",
    "CommunityUrl": "sample string 4",
    "SchedulerUrl": "sample string 5",
    "LogoUrl": "sample string 6",
    "Patronage": {
      "$ref": "1"
    },
    "Companies": [
      {
        "$id": "2",
        "CompanyId": 1,
        "CompanyName": "sample string 2",
        "CompanyUrl": "sample string 3",
        "LogoUrl": "sample string 4",
        "IsActive": true
      },
      {
        "$ref": "2"
      }
    ],
    "TrackingObjectGroup": {
      "$id": "3",
      "TrackingObjectGroupId": 1,
      "TrackingObjectGroupName": "sample string 2",
      "Description": "sample string 3",
      "Company": {
        "$ref": "2"
      },
      "Users": [
        {
          "$id": "4",
          "UserId": 1,
          "DriverId": "sample string 2",
          "Login": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "Company": {
            "$ref": "2"
          },
          "Creator": {
            "$ref": "4"
          },
          "Calendar": {
            "$id": "5",
            "CalendarId": 1,
            "CalendarName": "sample string 2"
          },
          "EmailAddress": "sample string 7",
          "PhoneNumber": "sample string 8",
          "TrackingObjectGroups": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ],
          "Role": 1,
          "IsActive": true,
          "UserGroup": {
            "$id": "6",
            "UserGroupId": 1,
            "UserGroupName": "sample string 2",
            "Users": [
              {
                "$ref": "4"
              },
              {
                "$ref": "4"
              }
            ]
          },
          "Messages": [
            {
              "$id": "7",
              "MessageId": 1,
              "IsRead": true,
              "Content": "sample string 3",
              "Location": {
                "$id": "8",
                "Latitude": 1.1,
                "Longitude": 2.1,
                "AreaName": "sample string 2, sample string 2"
              },
              "Recipient": {
                "$ref": "4"
              },
              "IsHighPriority": true,
              "SentDate": "2026-02-02T19:50:06.6554133+01:00"
            },
            {
              "$ref": "7"
            }
          ],
          "NotificationType": 1,
          "NotificationSound": 0,
          "TrackingObject": {
            "$id": "9",
            "TrackingObjectId": 1,
            "TrackingObjectName": "sample string 2",
            "Company": {
              "$ref": "2"
            },
            "Device": {
              "$id": "10",
              "DeviceId": 1,
              "SenderId": "sample string 2",
              "InstalledSIMCard": {
                "$id": "11",
                "SIMCardId": 1,
                "SerialNumber": "sample string 2",
                "AddressIP": "sample string 3",
                "PIN": "sample string 4",
                "PUK": "sample string 5",
                "PhoneNumber": "sample string 6",
                "ActivationDate": "2026-02-02T19:50:06.6554133+01:00",
                "ExpirationDate": "2026-02-02T19:50:06.6554133+01:00",
                "Device": {
                  "$ref": "10"
                }
              },
              "Model": "sample string 3",
              "SerialNumber": "sample string 5",
              "IsActive": true,
              "CAN": true,
              "DeviceFeatures": 1,
              "DeviceType": 0,
              "TrackingObject": {
                "$ref": "9"
              }
            },
            "Driver": {
              "$ref": "4"
            },
            "TrackingObjectGroups": [
              {
                "$ref": "3"
              },
              {
                "$ref": "3"
              }
            ],
            "IsActive": true,
            "Note": "sample string 4",
            "Tank": {
              "$id": "12",
              "TankId": 1,
              "TankName": "sample string 2",
              "Capacity": 3,
              "Ratio": 64,
              "Threshold": 5.1,
              "Lag": 6,
              "Measures": [
                {
                  "$id": "13",
                  "MeasureId": 1,
                  "Input": 2.1,
                  "Output": 3.1
                },
                {
                  "$ref": "13"
                }
              ],
              "Inputs": [
                {
                  "$id": "14",
                  "TankInputId": 1,
                  "AnalogInput": 2,
                  "Coefficient": 3.1,
                  "InputIndex": 1
                },
                {
                  "$ref": "14"
                }
              ],
              "ToleranceDefueling": 7.1,
              "ToleranceFuelLevel": 8.1,
              "InputIndex": 9,
              "IsIgnoreEngineStatus": true
            },
            "TankDate": "2026-02-02T19:50:06.6554133+01:00",
            "RegistrationNumber": "sample string 5",
            "MakeModel": "sample string 7 sample string 6",
            "Model": "sample string 6",
            "Manufacturer": "sample string 7",
            "InitialOdometerValue": 1,
            "ReportsOdometer": true,
            "SpeedLimit": 1,
            "ReferenceFuelConsumption": 1.1,
            "MaxRPM": 1,
            "VIN": "sample string 9",
            "TrackingObjectType": 0,
            "FuelType": 0,
            "Sensors": [
              {
                "$id": "15",
                "SensorId": 1,
                "SensorName": "sample string 2",
                "SensorType": 0,
                "SensorOutputType": 0,
                "FunctionCode": "sample string 3",
                "Order": 64,
                "Mask": "sample string 5",
                "Visible": true,
                "Value": {
                  "$id": "16"
                }
              },
              {
                "$ref": "15"
              }
            ],
            "HasLocationData": true,
            "Logbook": true
          },
          "Metadata": {
            "$id": "17",
            "LoginSuccessful": "2026-02-02T19:50:06.6554133+01:00",
            "LoginFailed": "2026-02-02T19:50:06.6554133+01:00"
          }
        },
        {
          "$ref": "4"
        }
      ],
      "TrackingObjects": [
        {
          "$ref": "9"
        },
        {
          "$ref": "9"
        }
      ],
      "GroupSenderId": "sample string 4"
    }
  },
  {
    "$ref": "1"
  }
]
application/xml

Sample:
Sample not available.
text/xml

Sample:
Sample not available.