GPSoverIP API

https://docs.gpsoverip.de/api/
Admin
GPSoverIP API is a REST-based platform for integrating GPS tracking, fleet management, driver...
Tokens:100,731
Snippets:290
Trust Score:7.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Vacation Replacements (JSON Example)

Source: https://docs.gpsoverip.de/api/index

Example JSON response for retrieving vacation replacements. It includes basic replacement details like id, vacation, contact, and creation timestamp.

```json
[
    {
        "id": 1,
        "vacation": 15,
        "contact": 200116321,
        "created": "2024-06-21T10:57:07.000Z"
    }
]
```

--------------------------------

### Get Device Data Example (JSON)

Source: https://docs.gpsoverip.de/api/index

This snippet demonstrates a typical JSON response when querying for device information. It includes various details about the device, its contract, and associated identifiers. The structure is an array of device objects.

```json
[
    {
        "serial": "700010",
        "id": 8425,
        "dId": 99123055,
        "carColor": "red",
        "carPlate": "SW-AJ 22 äöü",
        "carChassis": "VF43F467HGH7123",
        "carYearConstruction": "2014-12-22T00:00:00.000Z",
        "carServiceInithours": 0,
        "uniqueId": "96b",
        "name": "Internes Testgerät 700010",
        "accId": 100100,
        "gpsaccUserId": 2,
        "gpsaccId": 83368553,
        "status": 5,
        "mode": 8,
        "phone": "00882285001715837",
        "antenneGpsId": null,
        "antenneGsmId": null,
        "description": "Fahrer Handynummer: 0151/16167931\r\n\r\nIN1 ist IRREPARABEL\r\n\r\nDefekt CLP-WS 570",
        "contractId": 102326573,
        "contractStart": "2021-04-26T00:00:00.000Z",
        "contractEnd": "2023-04-25T00:00:00.000Z",
        "contractCanceledAt": null,
        "contractCancel": null,
        "contractSleepStart": null,
        "contractSleepEnd": null,
        "contractPrepaidEnd": null,
        "password": "xxxx",
        "locked": false,
        "customerCostcenter": "CC123",
        "customerMode": 0,
        "customerTempSummand": 0,
        "customerTempGradient": 0,
        "customerCartype": null,
        "customerComment": "J",
        "customerCarPhone": "0174234234123",
        "invId": 102431168,
        "deleted": 0,
        "driversbookDelta": null,
        "gpsaccIdDriversbook": null,
        "driversbookWorktimeStart": null,
        "driversbookWorktimeEnd": null,
        "pCode": "IN1V2_TMC",
        "pId": 99852621,
        "pName": "IN1 V2 MIT TMC UMBAU - GPSauge",
        "simId": 104329650,
        "simPhone": "00882285001715837",
        "simdNr": "89882280000001049598",
        "roam": 1,
        "share": 0,
        "alt": null,
        "sms": true,
        "bis": null,
        "catrelSortnum": 1,
        "kdId": null,
        "catId": null,
        "driversbookWorktimeHideprivate": false,
        "vVendorId": 98456276,
        "vModelId": 98999592,
        "customerServiceIntervalH": null,
        "customerServiceIntervalKm": null,
        "tankinhalt": 55,
        "vClassId": null,
        "enginePower": 374,
        "tare": 2300,
        "maxAxle": 1800,
        "vTypeId": true,
        "customerBst": "",
        "enginePowerKw": 275,
        "customerLineType": ""
    }
]

```

--------------------------------

### Get Detailed Vacation Replacements (JSON Example)

Source: https://docs.gpsoverip.de/api/index

Example JSON response for retrieving detailed vacation replacements, including nested vacation and contact objects. This response provides more comprehensive information about the vacation and the associated contact.

```json
[
    {
        "id": 1,
        "vacation": {
            "id": 15,
            "contact": 200116321,
            "start": "2024-01-23",
            "end": "2024-03-03",
            "isHalfDay": false,
            "approvementState": 1,
            "approvedBy": null,
            "approved": "2024-04-26T12:15:14.000Z",
            "created": "2024-04-26T12:15:14.000Z",
            "modified": null
        },
        "contact": {
            "id": 200116321,
            "salutation": "1",
            "firstName": "Max",
            "lastName": "Mustermann",
            "email": "",
            "phone": "",
            "mobile": "",
            "title": "",
            "department": "Buero",
            "fax": "",
            "email2": "",
            "phone2": "",
            "phoneHome": null
        },
        "created": "2024-06-21T10:57:07.000Z"
    }
]
```

--------------------------------

### Get Rules API Example

Source: https://docs.gpsoverip.de/api/index

This code snippet shows how to retrieve a list of rules using the 'GET Rules' API endpoint. Optional query parameters like 'mode' and 'deleted' can be used for filtering. The response includes detailed information about each rule, such as its ID, name, status, and associated metadata.

```javascript
fetch('/api/v1/rules?mode=80&deleted=false', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Get Rules Details API Example

Source: https://docs.gpsoverip.de/api/index

This code snippet illustrates how to fetch detailed information for specific rules using the 'GET Rules Details' API endpoint. This endpoint is part of the rules management functionality and provides comprehensive data for each rule.

```javascript
fetch('/api/v1/rules/details', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Get Battery Usages API Example

Source: https://docs.gpsoverip.de/api/index

This code snippet demonstrates how to call the 'GET Battery Usages' API endpoint. It requires a 'from' and 'to' datetime parameter and returns an array of usage objects, each containing device information, time ranges, and creation timestamps.

```javascript
fetch('/api/v1/usages/battery?from=2025-04-14T10:30:36.000Z&to=2025-04-16T06:35:54.802Z', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Example Break Plan Response (JSON)

Source: https://docs.gpsoverip.de/api/index

This snippet shows an example of a successful response when retrieving break plan data. It details the structure of a break plan object, including its ID, name, duration, timing, creation details, user association, strictness flag, and deletion timestamp.

```json
[
    {
        "id": 2,
        "name": "Pause nach 6 Stunden",
        "duration": 30,
        "start": null,
        "end": null,
        "created": "2024-04-02T11:54:08.000Z",
        "user": null,
        "isStrict": true,
        "after": 360,
        "deleted": null
    }
]
```

--------------------------------

### Create Vacation Replacement (Request Body Example)

Source: https://docs.gpsoverip.de/api/index

Example of a request body for creating a vacation replacement. It specifies the vacation ID, the contact ID for the replacement, and an option to return the inserted objects.

```json
{
  "vacation": 15,
  "contacts": 200116321,
  "returnResult": true
}
```

--------------------------------

### Example Position Data Response (JSON)

Source: https://docs.gpsoverip.de/api/index

An example of the JSON response structure for the 'Positions' endpoint, showcasing the 'data' array containing individual position records and the 'meta' object with column definitions and device count.

```json
{
    "data": [
        [
            899994,
            "2019-01-01T23:59:58.000Z",
            50.03635,
            10.208407,
            101.9,
            348,
            230,
            8,
            1104784.75,
            0
        ],
        [
            899994,
            "2019-01-01T23:59:59.000Z",
            50.037212,
            10.208202,
            101.9,
            354,
            230,
            8,
            1104784.75,
            0
        ]
    ],
    "meta": {
        "columns": [
            {
                "name": "device_id",
                "type": "int",
                "info": "Id of the device."
            },
            {
                "name": "timestamp_utc",
                "type": "datetime",
                "info": "Position's timestamp in utc format."
            },
            {
                "name": "latitude",
                "type": "float",
                "info": "Latitude part of the position."
            },
            {
                "name": "longitude",
                "type": "float",
                "info": "Longitude part of the position."
            },
            {
                "name": "speed",
                "type": "float",
                "info": "Current speed in km/h."
            },
            {
                "name": "heading",
                "type": "float",
                "info": "Current heading of the device where 0 is north."
            },
            {
                "name": "altitude",
                "type": "int",
                "info": "Current height above zero of the device."
            },
            {
                "name": "satellite_count",
                "type": "int",
                "info": "Current count of satellites."
            },
            {
                "name": "mileage",
                "type": "float",
                "info": "Current mileage of the device."
            },
            {
                "name": "customizable_data",
                "type": "int",
                "info": "Current customizable data of the device."
            }
        ],
        "deviceCount": 10
    }
}

```

--------------------------------

### GPSTracker API - NoMeta Response Example

Source: https://docs.gpsoverip.de/api/index

Example of a response from the GPSTracker API when the 'nometa' parameter is present, indicating that only data, without metadata, should be returned. The structure includes timestamps and other relevant data points.

```json
{
 "data": [
     [
         "2020-07-14T13:27:00+02:00",
         "",
         ""
     ],
     [
         "2020-07-14T13:26:00+02:00",
         "",
         ""
     ]
      69596,
      16554,
      "4577.75",
      68760,
      "can",
      "",
      "",
      13
 ]
}
```

--------------------------------

### Get Device Activity (JSON Example)

Source: https://docs.gpsoverip.de/api/index

This JSON array represents the activity of a specific device over time. Each object indicates the device ID and the year, month, and day of activity. The 'day' field may be null if activity is aggregated by month or year.

```json
[
    {
        "device": 900001,
        "year": 2022,
        "month": 6,
        "day": null
    },
    {
        "device": 900001,
        "year": 2022,
        "month": 7,
        "day": null
    },
    {
        "device": 900001,
        "year": 2022,
        "month": 8,
        "day": null
    },
    {
        "device": 900001,
        "year": 2022,
        "month": 9,
        "day": null
    },
    {
        "device": 900001,
        "year": 2022,
        "month": 10,
        "day": null
    },
    {
        "device": 900001,
        "year": 2023,
        "month": 1,
        "day": null
    },
    {
        "device": 900001,
        "year": 2023,
        "month": 2,
        "day": null
    },
    {
        "device": 900001,
        "year": 2023,
        "month": 4,
        "day": null
    },
    {
        "device": 900001,
        "year": 2023,
        "month": 7,
        "day": null
    }
]
```

--------------------------------

### Example Position Data Array (JSON)

Source: https://docs.gpsoverip.de/api/index

An example of the 'data' array from the 'Positions' endpoint response, containing an array of arrays, where each inner array represents a single position record.

```json
[
    [
        899994,
        "2019-01-01T23:59:58.000Z",
        50.03635,
        10.208407,
        101.9,
        348,
        230,
        8,
        1104784.75,
        0
    ],
    [
        899994,
        "2019-01-01T23:59:59.000Z",
        50.037212,
        10.208202,
        101.9,
        354,
        230,
        8,
        1104784.75,
        0
    ]
]

```

--------------------------------

### POST Vacations Request Body Example

Source: https://docs.gpsoverip.de/api/index

This JSON object demonstrates the required fields for creating a new vacation. It specifies the contact, vacation type, start date, and optionally the end date, half-day status, and whether to return the result.

```json
{
  "contact": 12345,
  "type": 1,
  "start": "2024-07-01",
  "end": "2024-07-05",
  "isHalfDay": false,
  "returnResult": true
}
```

--------------------------------

### GET Rules

Source: https://docs.gpsoverip.de/api/index

Returns the rules configured in the system. Requires user permission.

```APIDOC
## GET /Rules

### Description
Returns the rules.

### Method
GET

### Endpoint
/Rules

### Parameters
#### Query Parameters
- **mode** (Integer) - Optional - Filter on modes can be comma separated.
- **deleted** (Boolean) - Optional - Filter on deleted status.

### Response
#### Success Response (200)
- **rules** (Object[]) - The rules objects.
  - **id** (Integer) - The id of the rule.
  - **name** (String) - The name of the rule.
  - **description** (String) - The description of the rule.
  - **statusID** (Integer) - The status ID of the rule.
  - **typeID** (Integer) - The type ID of the rule.
  - **modeID** (Integer) - The mode ID of the rule.
  - **value** (Integer) - The value of the rule.
  - **deleteAfterExec** (Boolean) - Indicates if the rule should be deleted after execution.
  - **modifiedTime** (Datetime) - The time the rule was last modified.
  - **user** (Integer) - The user associated with the rule.
  - **crmReferenceID** (Integer) - The CRM reference ID for the rule.
  - **deleted** (Boolean) - Indicates if the rule is deleted.
  - **latitude** (Float) - The latitude associated with the rule.
  - **longitude** (Float) - The longitude associated with the rule.
  - **message** (String) - A message associated with the rule.
  - **from** (String) - The start time for the rule.
  - **to** (String) - The end time for the rule.
  - **scheduleTime** (Datetime) - The scheduled time for the rule.
  - **activateOnEngineOff** (Boolean) - Indicates if the rule should activate on engine off.
  - **scheduled** (Boolean) - Indicates if the rule is scheduled.
  - **parentRuleID** (Integer) - The parent rule ID.
  - **routePart** (Integer) - The route part associated with the rule.

#### Response Example
```json
[
    {
        "id": 143251441,
        "name": "Überwachung HAS - Zeil",
        "description": "",
        "statusID": 1,
        "typeID": 17,
        "modeID": 80,
        "value": 1000,
        "deleteAfterExec": false,
        "modifiedTime": "2022-07-15T09:12:16.517Z",
        "user": 2,
        "crmReferenceID": 143250954,
        "deleted": false,
        "latitude": null,
        "longitude": null,
        "message": "",
        "from": "",
        "to": "",
        "scheduleTime": "1900-01-01T00:00:00.000Z",
        "activateOnEngineOff": false,
        "scheduled": false,
        "parentRuleID": -1,
        "routePart": -1
    },
    {
        "id": 143251443,
        "name": "Ausfahrt-Start",
        "description": "Ausfahrt-Start von Strecke: HAS - Zeil",
        "statusID": 1,
        "typeID": 1,
        "modeID": 3,
        "value": 1000,
        "deleteAfterExec": false,
        "modifiedTime": "2022-07-15T09:12:16.593Z",
        "user": 2,
        "crmReferenceID": null,
        "deleted": false,
        "latitude": 5002.1359,
        "longitude": 1030.7045,
        "message": "",
        "from": "",
        "to": "",
        "scheduleTime": "1900-01-01T00:00:00.000Z",
        "activateOnEngineOff": false,
        "scheduled": false,
        "parentRuleID": 143251441,
        "routePart": 1
    }
]
```
```

--------------------------------

### Delete Week Plans (Request Body Example)

Source: https://docs.gpsoverip.de/api/index

Example of a request body for deleting week plans. It requires a list of IDs for the week plans to be deleted.

```json
{
  "ids": [1, 2, 3]
}
```

--------------------------------

### Get Cost Attachments - Success Response Example

Source: https://docs.gpsoverip.de/api/index

Illustrates the structure of a successful response when retrieving attachment information for costs. The response contains an array of media objects, each with an ID, associated cost ID, name, MIME type, creation timestamp, and URLs for downloading the attachment and its preview.

```json
[
    {
        "id": 1,
        "cost": 14946,
        "name": "20211220_quickstart_restpush_1_6_v01.pdf",
        "mimeType": "application/pdf",
        "created": "2025-01-10T12:31:48.000Z",
        "url": "https://api.gpsoverip.de/v1/downloads/media?key=d6fae8120895b787fa3c018327b069bc%3Aab6204df972e0c5e729ad8f6aa1f332507f59405538cb035dcd68c728fe442f690ac21b9f26a7289889475d7a27eb14c",
        "previewUrl": "https://api.gpsoverip.de/v1/downloads/media?key=d6fae8120895b787fa3c018327b069bc%3Aab6204df972e0c5e729ad8f6aa1f332507f59405538cb035dcd68c728fe442f6038ead7d18d0e2e318266a152a6db2c9aa33c8b4548cb07cd7c030eddd9f739a"
    },
    {
        "id": 2,
        "cost": 14946,
        "name": "test.png",
        "mimeType": "image/png",
        "created": "2025-01-10T12:31:48.000Z",
        "url": "https://api.gpsoverip.de/v1/downloads/media?key=d6fae8120895b787fa3c018327b069bc%3Abaffbda7b3363487ab3c724d01a66d7a89f7ae0162d28221a58490a15cc1c2022bfdde0e7ada04ce012b7668dc771221",
        "previewUrl": "https://api.gpsoverip.de/v1/downloads/media?key=d6fae8120895b787fa3c018327b069bc%3Abaffbda7b3363487ab3c724d01a66d7a89f7ae0162d28221a58490a15cc1c2025dc70d2e5cac2695ddaa4d67693400a72ef7391a1afa7b292bfbaee89305fa69"
    }
]
```

--------------------------------

### GPSTracker API - Success Response Example

Source: https://docs.gpsoverip.de/api/index

Example of a successful response from the GPSTracker API, containing data and metadata. The data array includes nested arrays and values representing timestamps, durations, and other metrics.

```json
{
 "data": [
     [
      [
          "2021-04-26T22:04:08.000Z",
          "",
          ""
      ],
      [
          "2021-04-27T21:59:59.999Z",
          "",
          ""
      ],
      69596,
      16554,
      "4577.75",
      68760,
      "can",
      "",
      "",
      13
  ]
 ],
	"meta": {
		"columns": [
             {
                  "name": "date",
                  "type": "string",
                  "info": "Timestamp of first position"
              },
              {
                  "name": "lat",
                  "type": "string",
                  "info": "Currently not in use"
              },
              {
                  "name": "lon",
                  "type": "string",
                  "info": "Currently not in use"
              }
          ],
          [
              {
                  "name": "date",
                  "type": "string",
                  "info": "Timestamp of last position"
              },
              {
                  "name": "lat",
                  "type": "string",
                  "info": "Currently not in use"
              },
              {
                  "name": "lon",
                  "type": "string",
                  "info": "Currently not in use"
              }
          ],
          {
              "name": "duration",
              "type": "int",
              "info": "Total duration of this day"
          },
          {
              "name": "idle",
              "type": "int",
              "info": "Total idle time of this day"
          },
          {
              "name": "operatingTime",
              "type": "String",
              "info": "Total operating time of this day"
          },
          {
              "name": "operatingTimeDiff",
              "type": "int",
              "info": "The difference of total operating time from start to end of the package"
          },
          {
              "name": "source",
              "type": "String",
              "info": "The source of the data"
          },
          {
              "name": "temperature",
              "type": "String",
              "info": "Currently not in use"
          },
          {
              "name": "comment",
              "type": "String",
              "info": "Currently not in use"
          },
          {
              "name": "count",
              "type": "int",
              "info": "Total number of Packages (only available with type total)"
          }
     ]
  }
}
```

--------------------------------

### Success Response for Get Time Groups Assignments (JSON)

Source: https://docs.gpsoverip.de/api/index

Example of a successful response when retrieving time group assignments. Each assignment includes an ID, start and end dates, and references to the assigned time group and contact.

```json
[
    {
        "id": 1,
        "start": "2024-01-01",
        "end": "2024-02-02",
        "timeGroup": 2,
        "contact": 207322983,
        "created": "2024-04-12T14:51:15.000Z"
    }
]
```

--------------------------------

### Get Rides Success Response

Source: https://docs.gpsoverip.de/api/index

Example of a successful response when retrieving ride data. It returns an array of ride objects, each containing details like id, device, start and end times, contactID, driverCard, source, and driverNr.

```json
[
    {
        "id": 10044,
        "device": 700010,
        "start": "2023-10-05T00:00:00.000Z",
        "end": "2023-10-06T00:00:00.000Z",
        "contactID": 104023216,
        "driverCard": null,
        "source": 4,
        "driverNr": 1
    },
    {
        "id": 6271805,
        "device": 700940,
        "start": "2019-08-19T03:05:13.000Z",
        "end": "2019-08-19T13:24:12.000Z",
        "contactID": null,
        "driverCard": "DF00018940246001",
        "isExternal": false,
        "source": 1,
        "user": null,
        "created": null,
        "driverNr": 1
    }
]
```

--------------------------------

### FMS-Aggregation | GET Difference (Version 1.1.0)

Source: https://docs.gpsoverip.de/api/index

Returns the calculated change of the given FMS fields between start and end timestamp or start and end of the day.

```APIDOC
## GET /websites/gpsoverip_de_api/fms-aggregation/difference

### Description
Returns the calculated change of the given FMS fields between the start and end timestamp, or between the start and end of the day.

### Method
GET

### Endpoint
/websites/gpsoverip_de_api/fms-aggregation/difference

### Parameters
#### Query Parameters
- **devices** (String) - Required - Devices, can be comma separated.
- **fields** (String) - Required - Fields, can be comma separated.
- **from** (Datetime) - Required - Start of the period (YYYY-MM-DDTHH:mm:ssZ).
- **to** (Datetime) - Optional - End of the period (YYYY-MM-DDTHH:mm:ssZ), if end is in the future current timestamp is used.

### Response
#### Success Response (200)
- **device** (Integer) - The ID of the device.
- **field** (String) - The name of the field.
- **timestamp** (String) - The timestamp of the data point.
- **value** (String) - The calculated change value.

#### Response Example
(Response structure is similar to the other difference endpoint, specific examples not provided in source text for this version.)
```

--------------------------------

### Example API Response for Winter Service Tours Data

Source: https://docs.gpsoverip.de/api/index

This JSON object provides a sample response for winter service tours data. It includes job IDs, device information, time spans for service, and aggregated distance and time data for different activities like spreading and plowing.

```json
[
    {
        "device": 706706,
        "jobID": 162482321,
        "from": "2022-12-11T04:54:56.000Z",
        "serviceStart": "2022-12-11T05:02:26.000Z",
        "serviceEnd": "2022-12-11T07:20:51.000Z",
        "to": "2022-12-11T07:56:39.000Z",
        "km": 51.296,
        "spreading": {
            "km": 23.305,
            "seconds": 2454
        },
        "spreadingAndPlowing": {
            "km": 0,
            "seconds": 0
        },
        "plowing": {
            "km": 0,
            "seconds": 0
        },
        "driving": {
            "km": 27.991,
            "seconds": 2193
        },
        "actualUsageSolid": 1414,
        "actualUsageFluid": 0,
        "actualUsageFluidInL": 0,
        "arrival": {
            "km": 27.991,
            "seconds": 2193
        },
        "departure": {
            "km": 27.991,
            "seconds": 2193
        }
    },
    {
        "device": 706706,
        "jobID": 162608400,
        "from": "2022-12-12T04:25:01.000Z",
        "serviceStart": "2022-12-12T04:41:42.000Z",
        "serviceEnd": "2022-12-12T08:30:00.000Z",
        "to": "2022-12-12T08:58:54.000Z",
        "km": 102.505,
        "spreading": {
            "km": 58.429,
            "seconds": 6074
        }
```

--------------------------------

### Get Working Hours Overview | GET

Source: https://docs.gpsoverip.de/api/index

Retrieves an overview of working hours data for a specified period. It supports filtering by fields, contacts, and details inclusion. The start and end dates are mandatory query parameters.

```HTTP
GET /api/v1/humanresources/workinghours/overview?start=2023-01-01&end=2023-12-31&fields=workDate,hours&contacts=1,2&includeDetails=true HTTP/1.1
Host: gpsoverip.de
```

--------------------------------

### POST /DriverQualifications

Source: https://docs.gpsoverip.de/api/index

Creates a new driver qualification record.

```APIDOC
## POST /DriverQualifications

### Description
Creates driver qualification.

### Method
POST

### Endpoint
/DriverQualifications

### Parameters
#### Request Body
- **id** (Integer) - Required - The id of the qualification.

### Response
#### Success Response (200)
- Response is empty.
```

--------------------------------

### GET Assigned Break Plans - Success Response (Detailed)

Source: https://docs.gpsoverip.de/api/index

Example of a detailed success response for the GET Assigned Break Plans endpoint when 'includeDetails' is set to true. It includes nested objects for 'dayPlan' and 'breakPlan' with their respective properties.

```JSON
[
    {
        "dayPlan": {
            "id": 1,
            "name": "Regelarbeitszeit 08:00 - 17:00",
            "targetTime": 480,
            "coreTimeStart": 480,
            "coreTimeEnd": 1020,
            "frameTimeStart": 420,
            "frameTimeEnd": 1080,
            "user": null,
            "created": "2024-04-03T06:51:50.000Z",
            "isWorkday": true,
            "deleted": null
        },
        "breakPlan": {
            "id": 2,
            "name": "Pause nach 6 Stunden",
            "duration": 30,
            "start": null,
            "end": null,
            "created": "2024-04-02T11:54:08.000Z",
            "user": null,
            "isStrict": true,
            "after": 360
        },
        "user": 2,
        "created": "2024-04-05T14:23:30.000Z"
    }
]
```

--------------------------------

### POST /websites/gpsoverip_de_api/workingHoursMonitoring

Source: https://docs.gpsoverip.de/api/index

Creates a working hours monitoring profile.

```APIDOC
## POST /websites/gpsoverip_de_api/workingHoursMonitoring

### Description
Creates a working hours monitoring profile.

### Method
POST

### Endpoint
/websites/gpsoverip_de_api/workingHoursMonitoring

### Permissions
user

### Request Body
- (No specific fields defined in the provided text for the request body, but typically would include profile configuration details.)

### Response
#### Success Response (200)
- (Response details not specified in the provided text.)
```

--------------------------------

### GET Assigned Break Plans - Success Response (Basic)

Source: https://docs.gpsoverip.de/api/index

Example of a basic success response for the GET Assigned Break Plans endpoint. It returns an array of break plan assignments, each containing the day plan, break plan, user, and creation timestamp.

```JSON
[
    {
        "dayPlan": 1,
        "breakPlan": 2,
        "user": -99,
        "created": "2024-04-05T14:23:30.000Z"
    }
]
```

--------------------------------

### GET /websites/gpsoverip_de_api/fms/joker

Source: https://docs.gpsoverip.de/api/index

Retrieves calculated FMS joker values with FMS archive data from a specified start to end timestamp. Supports filtering by devices and a joker ID.

```APIDOC
## GET /websites/gpsoverip_de_api/fms/joker

### Description
Returns the calculated FMS joker values with fms archive data from start to end timestamp.

### Method
GET

### Endpoint
/websites/gpsoverip_de_api/fms/joker

### Parameters
#### Query Parameters
- **from** (Datetime) - Required - Start of the period (YYYY-MM-DDTHH:mm:ssZ).
- **to** (Datetime) - Optional - End of the period (YYYY-MM-DDTHH:mm:ssZ), if end is in the future current timestamp is used.
- **devices** (String) - Optional - Devices, can be comma separated.
- **joker** (Long) - Optional - Joker ID to be calculated.
- **nometa** (Any) - Optional - Only return data in response when parameter is present. Value is ignored.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (Array) - Array of arrays, where each inner array contains timestamp, device ID, and calculated value.
- **meta** (Object) - Metadata about the columns returned in the data.
  - **columns** (Array) - Array of column definitions.
    - **name** (String) - The name of the column.
    - **type** (String) - The data type of the column.
    - **info** (String) - Description of the column.

#### Response Example
```json
{
    "data": [
        [
            "2020-07-14T13:27:00+02:00",
            701526,
            830392.32
        ],
        [
            "2020-07-14T13:26:00+02:00",
            701123,
            830323.32
        ]
    ],
    "meta": {
        "columns": [
            {
                "name": "timestamp",
                "type": "datetime",
                "info": "Timestamp of the value"
            },
            {
                "name": "device",
                "type": "int",
                "info": "DeviceId"
            },
            {
                "name": "value",
                "type": "float",
                "info": "Calculated joker value"
            }
        ]
    }
}
```

#### NoMeta-Response Example
```json
[
    [
        "2020-07-14T13:27:00+02:00",
        701526,
        830392.32
    ],
    [
        "2020-07-14T13:26:00+02:00",
        701123,
        830323.32
    ]
]
```
```

--------------------------------

### Example API Response for Winter Service Data

Source: https://docs.gpsoverip.de/api/index

This JSON object represents a sample response from the API for winter service data. It includes details about device activity, location, time, distance, and usage metrics.

```json
[
    {
        "device": 706889,
        "streetName": "UNNAMED",
        "wayName": "UNNAMED",
        "from": "2022-12-08T01:55:01.000Z",
        "to": "2022-12-08T01:55:06.000Z",
        "timespan": 5,
        "km": 0.02,
        "activity": {
            "id": 2,
            "label": "driving"
        },
        "mode": 0,
        "spreadingWidth": 0,
        "dosage": 0,
        "targetUsage": 0,
        "actualUsageSolid": 0,
        "actualUsageFluid": 0,
        "actualUsageFluidInL": 0,
        "plowingOn": false,
        "plowingDistance": 0,
        "waySectionNumber": null
    },
    {
        "device": 706889,
        "streetName": "UNNAMED",
        "wayName": "UNNAMED",
        "from": "2022-12-08T01:55:06.000Z",
        "to": "2022-12-08T01:55:09.000Z",
        "timespan": 3,
        "km": 0.042,
        "activity": {
            "id": 3,
            "label": "spreading"
        },
        "mode": 2,
        "spreadingWidth": 3.5,
        "dosage": 10,
        "targetUsage": 1.47,
        "actualUsageSolid": 0.3,
        "actualUsageFluid": 0.3,
        "actualUsageFluidInL": 0.15,
        "plowingOn": false,
        "plowingDistance": 0,
        "waySectionNumber": null
    },
    {
        "device": 706889,
        "streetName": "B275",
        "wayName": "Abs 55210095522022  , AbsNr. 8500 auf der B 275 ",
        "from": "2022-12-08T01:55:09.000Z",
        "to": "2022-12-08T01:55:16.000Z",
        "timespan": 7,
        "km": 0.031,
        "activity": {
            "id": 3,
            "label": "spreading"
        },
        "mode": 2,
        "spreadingWidth": 3.5,
        "dosage": 10,
        "targetUsage": 1.085,
        "actualUsageSolid": 0.7,
        "actualUsageFluid": 0.7,
        "actualUsageFluidInL": 0.35,
        "plowingOn": false,
        "plowingDistance": 0,
        "waySectionNumber": 300
    },
    {
        "device": 706889,
        "streetName": "B275",
        "wayName": "Abs 55210095522022  , AbsNr. 8500 auf der B 275 ",
        "from": "2022-12-08T01:55:16.000Z",
        "to": "2022-12-08T01:55:26.000Z",
        "timespan": 10,
        "km": 0.069,
        "activity": {
            "id": 3,
            "label": "spreading"
        },
        "mode": 2,
        "spreadingWidth": 3.5,
        "dosage": 13,
        "targetUsage": 3.14,
        "actualUsageSolid": 1,
        "actualUsageFluid": 1,
        "actualUsageFluidInL": 0.5,
        "plowingOn": false,
        "plowingDistance": 0,
        "waySectionNumber": 300
    },
    {
        "device": 706889,
        "streetName": "B275",
        "wayName": "Abs 55210095522022  , AbsNr. 8500 auf der B 275 ",
        "from": "2022-12-08T01:55:26.000Z",
        "to": "2022-12-08T01:55:36.000Z",
        "timespan": 10,
        "km": 0.097,
        "activity": {
            "id": 3,
            "label": "spreading"
        },
        "mode": 2,
        "spreadingWidth": 5,
        "dosage": 13,
        "targetUsage": 6.305,
        "actualUsageSolid": 2,
        "actualUsageFluid": 1,
        "actualUsageFluidInL": 1,
        "plowingOn": false,
        "plowingDistance": 0,
        "waySectionNumber": 300
    }
]
```

--------------------------------

### GET /operating-hours-report

Source: https://docs.gpsoverip.de/api/index

Returns the calculated operating hour packages from start to end date or a single date. The timespan is limited to two weeks. Authentication by user and password is required.

```APIDOC
## GET /operating-hours-report

### Description
Returns the calculated operating hour packages from start to end date or a single date. The timespan is limited to two weeks. Currently it is not possible to request devices with ids 213000 to 214999 and 400000 to 409999. Authentication by user and password.

### Method
GET

### Endpoint
/operating-hours-report

### Parameters
#### Query Parameters
- **start_date** (Date) - Required - The start date for the report (YYYY-MM-DD).
- **end_date** (Date) - Required - The end date for the report (YYYY-MM-DD).

### Note
Devices with IDs from 213000 to 214999 and 400000 to 409999 are currently not supported for this report.
```

--------------------------------

### GET /websites/gpsoverip_de_api/weekplans

Source: https://docs.gpsoverip.de/api/index

Retrieves available week plans with optional filtering and detail inclusion.

```APIDOC
## GET /websites/gpsoverip_de_api/weekplans

### Description
Returns the available week plans. You can filter the results by name, ID, and control the inclusion of details for day plans and deleted entries.

### Method
GET

### Endpoint
/websites/gpsoverip_de_api/weekplans

### Parameters
#### Query Parameters
- **fields** (String) - Optional - Specifies the fields which should be returned. (can be comma separated)
- **names** (String) - Optional - Restriction on week plan names.
- **ids** (Integer) - Optional - Restriction on id. (can be comma separated)
- **includeDetails** (Boolean) - Optional - Specifies if the details to the day plans should be returned. Default value: `false`
- **includeDeleted** (Boolean) - Optional - Should deleted entries be included.
```

--------------------------------

### Get Messages Without Metadata (JSON Example)

Source: https://docs.gpsoverip.de/api/index

This snippet illustrates a simplified JSON response containing only the message data, without the accompanying metadata. It's useful when only the message content is required.

```json
[
           100,
           [
               [
                  10,
                  "Hello. This is an Example",
                  "2020-10-26T08:38:47.000Z",
                  true,
                  12345
               ],
               [
                  11,
                  "Hello. This is no Example",
                  "2020-10-26T08:39:47.000Z",
                  false,
                  12345
               ]
           ]
       ]
```

--------------------------------

### POST /websites/gpsoverip_de_api/DriverLicenses-Monitoring

Source: https://docs.gpsoverip.de/api/index

Creates a new driver license monitoring profile. The response is empty upon successful creation.

```APIDOC
## POST /websites/gpsoverip_de_api/DriverLicenses-Monitoring

### Description
Creates a new driver license monitoring profile. The response is empty upon successful creation.

### Method
POST

### Endpoint
/websites/gpsoverip_de_api/DriverLicenses-Monitoring

### Parameters
#### Request Body
- **monitor** (Boolean) - Required - Should profile be used for monitoring.
- **notifyDriver** (Boolean) - Required - Should the driver be notified. The driver's contact details will be used for notifications.
- **notifyResponsible** (Boolean) - Required - Should the responsible be notified. The responsible contact of the driver will be used for notifications.
- **notifyEmails** (String) - Optional - Specifies additional emails which should be notified if email notification is activated. Can be comma seperated.
- **daysUntilExpire** (Integer) - Required - Specifies how many days before you should be informed that the license or license class expires.
- **emailNotification** (Boolean) - Optional - Should be notified by email. Default value: `true`.
- **smsNotification** (Boolean) - Optional - Should be notified by sms. Feature not yet available. Default value: `false`.

### Response
#### Success Response (200)
- The response body is empty.

#### Response Example
```json
{}
```
```

--------------------------------

### FMS-TroubleCodes: Get FMS Trouble Codes (Example Response)

Source: https://docs.gpsoverip.de/api/index

Fetches descriptions for trouble codes based on specified types (SPN, FMI) and language. It can filter by specific SPN or FMI codes.

```json
{
    "spn": [
        {
            "code": 16,
            "description": "Motorkraftstofffilter (Saugseite) Differenzdruck"
        }
    ],
    "fmi": [
        {
            "code": 1,
            "description": "Spannung unter dem Normalwert"
        }
    ]
}
```
Tokens:
Raw