Features supported

• Support asynchronous invocation: NO
• Supports paging: YES
• Field selection: NO
• Supplemental data: YES

PagingSupplemental Data

curl --request GET \
  --url 'https://api.fareclock.com/devices?id=123&search=example&orgUnit=123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
id	integer	No	Numeric ID of the device
search	string	No	Case-insensitive full text search of device name
orgUnit	integer	No	Organization unit ID of the device
active	string	No	Allowed values: active or inactive

{
  "results": [
    {
      "id": 600,
      "name": "Clock #1",
      "active": true,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "clockSessionValid": true,
      "settingsPinAllowLabels": null,
      "geoRules": [],
      "geoProvider": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixJobName": null,
      "geoOverrideToDisabled": false,
      "bgGeoOverrideToDisabled": false,
      "language": "en",
      "clockSessionIpAddress": "192.168.1.50",
      "clockSessionUserAgent": "Fareclock Timeclock App",
      "clockSessionDeviceModel": "iPad Air",
      "clockSessionDeviceUuid": "uuid-123456",
      "clockSessionAppVersion": "3.5.7",
      "clockSessionSubmitLogs": false,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request POST \
  --url 'https://api.fareclock.com/devices' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Clock #1",
  "active": true,
  "orgUnit": 100,
  "language": "en"
}'

{
  "name": "Clock #1",
  "active": true,
  "orgUnit": 100,
  "language": "en"
}

{
  "results": [
    {
      "id": 600,
      "name": "Clock #1",
      "active": true,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "clockSessionValid": true,
      "settingsPinAllowLabels": null,
      "geoRules": [],
      "geoProvider": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixJobName": null,
      "geoOverrideToDisabled": false,
      "bgGeoOverrideToDisabled": false,
      "language": "en",
      "clockSessionIpAddress": "192.168.1.50",
      "clockSessionUserAgent": "Fareclock Timeclock App",
      "clockSessionDeviceModel": "iPad Air",
      "clockSessionDeviceUuid": "uuid-123456",
      "clockSessionAppVersion": "3.5.7",
      "clockSessionSubmitLogs": false,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request GET \
  --url 'https://api.fareclock.com/devices/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the device

{
  "results": [
    {
      "id": 600,
      "name": "Clock #1",
      "active": true,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "clockSessionValid": true,
      "settingsPinAllowLabels": null,
      "geoRules": [],
      "geoProvider": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixJobName": null,
      "geoOverrideToDisabled": false,
      "bgGeoOverrideToDisabled": false,
      "language": "en",
      "clockSessionIpAddress": "192.168.1.50",
      "clockSessionUserAgent": "Fareclock Timeclock App",
      "clockSessionDeviceModel": "iPad Air",
      "clockSessionDeviceUuid": "uuid-123456",
      "clockSessionAppVersion": "3.5.7",
      "clockSessionSubmitLogs": false,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request PUT \
  --url 'https://api.fareclock.com/devices/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Clock #1",
  "active": true,
  "orgUnit": 100,
  "language": "en"
}'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the device

{
  "name": "Clock #1",
  "active": true,
  "orgUnit": 100,
  "language": "en"
}

{
  "results": [
    {
      "id": 600,
      "name": "Clock #1",
      "active": true,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "clockSessionValid": true,
      "settingsPinAllowLabels": null,
      "geoRules": [],
      "geoProvider": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixJobName": null,
      "geoOverrideToDisabled": false,
      "bgGeoOverrideToDisabled": false,
      "language": "en",
      "clockSessionIpAddress": "192.168.1.50",
      "clockSessionUserAgent": "Fareclock Timeclock App",
      "clockSessionDeviceModel": "iPad Air",
      "clockSessionDeviceUuid": "uuid-123456",
      "clockSessionAppVersion": "3.5.7",
      "clockSessionSubmitLogs": false,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

Deletes the current active session associated with the device.

curl --request POST \
  --url 'https://api.fareclock.com/devices/123/reset' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data ''

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the device

Sends a command or sets a flag instructing the device to upload its application logs.

curl --request POST \
  --url 'https://api.fareclock.com/devices/123/request-logs' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data ''

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the device