This endpoint allows you to retrieve the list of available groups. It is useful for obtaining detailed information about each group, including its name, description, associated devices, and other relevant details. It is ideal for managing groups and verifying their data.
Authentication Required
Example Request
GET /api/groups HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXV...
Response Parameters
The response includes a list of groups along with specific details for each group.
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | Indicates whether the request was successful. |
| error | string | No | Error message if the request failed. |
| apiUsage | integer | No | Total API usage at the time of the request. |
| apiDailyUsage | integer | No | Daily API usage at the time of the request. |
| groups | array | No | List of available groups. Each group contains the following fields: |
| groups.id | string | No | Unique identifier of the group. |
| groups.name | string | Yes | Name of the group. |
| groups.description | string | No | Description of the group. |
| groups.devices | array | No | List of IDs of devices associated with the group. |
| groups.creation | string | No | Date and time of group creation (in ISO 8601 format). |
| groups.lastModified | string | No | Date and time of the last modification of the group (in ISO 8601 format). |
Example Successful Response
{
"success": true,
"error": null,
"apiUsage": 123,
"apiDailyUsage": 45,
"groups": [
{
"id": "grp-123",
"name": "Group A",
"description": "Description of Group A",
"devices": ["dev-456", "dev-789"],
"creation": "2023-01-01T12:00:00Z",
"lastModified": "2023-01-10T12:00:00Z"
},
{
"id": "grp-124",
"name": "Group B",
"description": "Description of Group B",
"devices": ["dev-012", "dev-345"],
"creation": "2023-02-01T12:00:00Z",
"lastModified": "2023-02-10T12:00:00Z"
}
]
}
Example Error Response
{
"success": false,
"error": "Unauthorized access",
"apiUsage": 123,
"apiDailyUsage": 45,
"groups": null
}
This endpoint is essential for managing and viewing groups within the Factory IL GPS application, allowing you to get a comprehensive and detailed view of each group and its associated devices.
Index
- Welcome to Factory IL GPS help
- Map
- Viewing a Device's Route History
- Device Control Panel
- Detailed Device Information
- Buttons on the Map
- Details
- Trip Statistics
- Device Menu
- GeoFences
- Bulk Alert Editing
- Enable map notifications
- Mileage Calculation
- Atributes
- Devices
- Marker Icon
- Information
- Sensors
- Reassign Digital Sensors
- Commands
- Alerts
- Types
- Configuration
- Reminders
- Limits
- History
- Setting Up a New Tracker
- Solution for Identifier Already in Use by Another Account
- Device Issues
- Email alerts sending limits
- Reports
- New Report
- My Account
- Password Change
- Email Notifications
- Telegram Accounts
- Update Mobile Phone Number
- Primary Email
- Alternative Email
- Activate Two-Factor Authentication (2FA)
- Access Log
- Password Recovery
- Recover Username
- Delete Your Account
- Statistics
- Activity Summary
- Groups
- Users
- Share Access
- Developers
- Enable the API
- Rest API
- Authentication
- Devices API
- GET /api/devices
- GET /api/devices/{deviceId}
- GET /api/devices/{deviceId}/lastLocation
- POST /api/devices/{deviceId}/locations
- POST /api/devices/{deviceId}/alerts
- Groups API
- GET /api/groups
- POST /api/groups
- GET /api/groups/{groupId}
- PUT /api/groups/{groupId}
- PATCH /api/groups/{groupId}
- DELETE /api/groups/{groupId}
- Users API
- GET /api/users
- POST /api/users
- GET /api/users/countries
- GET /api/users/timeZones
- GET /api/users/{userId}
- PUT /api/users/{userId}
- PATCH /api/users/{userId}
- DELETE /api/users/{userId}
Last modification: 2024-06-06 17:55:24