Check-ins

What a field employee reported from site, with a comment, a photo, and a filled form.

A check-in is what a field employee sends from where they are standing: the time, the address and coordinates, and whatever they added, which can be a comment, a photo, or a filled form. It is how someone on site tells the office what they found without a phone call, whether that is photographic proof of work done or a report of a fault.

Check-ins come from the Mobile Tracker App, for Android and iOS, rather than from this API. checkin/create exists for exceptional cases only and is described in how to work with check-ins, so treat this resource as read-mostly.

Check-in object

API actions

API base path: /checkin.

The conditions parameter of checkin/list takes search conditions.

Required sub-user rights: employee_update.

Read check-in

post

/checkin/read

Return one check-in by ID.

Check-ins are created from the Mobile Tracker App, not from this API, so the check-in operations are read-only apart from the exceptional-case create.

No specific right is required, only a valid session.

Also accepts GET with the same parameters as query-string values.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body

checkin_idinteger · min: 1Required

ID of the check-in.

Responses

200

The check-in

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

404

Error 204: no check-in with this ID belongs to the authorized user.

application/json

default

Error response object

application/json

post/checkin/read

POST /v2/checkin/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "checkin_id": 1
}

{
  "success": true,
  "value": {
    "id": 1,
    "marker_time": "text",
    "user_id": 1,
    "tracker_id": 1,
    "employee_id": null,
    "location": {
      "lat": 1,
      "lng": 1,
      "address": "text",
      "precision": 1
    },
    "comment": null,
    "files": [
      {
        "id": 1,
        "storage_id": 1,
        "user_id": 1,
        "type": "image",
        "created": "text",
        "uploaded": null,
        "name": "text",
        "size": 1,
        "mime_type": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "state": "created",
        "download_url": null,
        "bindings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "previews": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      }
    ],
    "form_id": null,
    "form_label": null
  }
}

Errors

These errors come in addition to the general error codes:

7 - Invalid parameters.
204 - Entity not found.

Required sub-user rights: employee_update.

List check-ins

post

/checkin/list

Return check-ins for a set of trackers over a period, as JSON or as a report file.

Setting format changes the response to a file download rather than JSON, which is the only way this operation differs from a plain list.

No specific right is required, only a valid session.

Authorizations

AuthorizationstringRequired

Body

trackersinteger[]Optional

Optional. Tracker IDs. None may be deleted or blocked. Without this, every available tracker is used.

fromstringOptional

Optional. Start of the period.

Example: 2026-08-24 09:00:00

tostringOptional

Optional. End of the period. Must be after from.

Example: 2026-08-24 09:00:00

sortstring[]Optional

Optional. Sort options, each a property and direction such as marker_time=desc. Sortable properties: employee (full name), employee_fullname, tracker_id, marker_time, location, address, comment, form, and form_label.

limitintegerOptional

Optional. Maximum number of records to return.

offsetintegerOptional

Optional. Default 0. Offset into the results, for pagination.

formatstring · enumOptional

Optional. Leave it out for JSON. Setting it returns a file download instead.

Possible values:

Responses

200

Matching check-ins, when format is not set

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

countintegerOptional

Total number of check-ins, ignoring pagination.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

403

Error 211: the requested time span is too big. Error 217: one of the given trackers does not exist, is blocked, or lacks the required plan features. Error 221: the device limit set for the user's dealer has been exceeded.

application/json

default

Error response object

application/json

post/checkin/list

POST /v2/checkin/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "trackers": [
    1
  ],
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00",
  "conditions": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "sort": [
    "text"
  ],
  "location": {
    "lat": 1,
    "lng": 1,
    "radius": 1
  },
  "limit": 1,
  "offset": 1,
  "format": "pdf"
}

{
  "success": true,
  "list": [
    {
      "id": 1,
      "marker_time": "text",
      "user_id": 1,
      "tracker_id": 1,
      "employee_id": null,
      "location": {
        "lat": 1,
        "lng": 1,
        "address": "text",
        "precision": 1
      },
      "comment": null,
      "files": [
        {
          "id": 1,
          "storage_id": 1,
          "user_id": 1,
          "type": "image",
          "created": "text",
          "uploaded": null,
          "name": "text",
          "size": 1,
          "mime_type": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "state": "created",
          "download_url": null,
          "bindings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "previews": [
            {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          ]
        }
      ],
      "form_id": null,
      "form_label": null
    }
  ],
  "count": 1
}

Errors

These errors come in addition to the general error codes:

7 - Invalid parameters.
211 - Requested time span is too big.
217 - The list contains non-existent entities - if one of the specified trackers does not exist, is blocked or doesn't have required tariff features.
221 - Device limit exceeded - if device limit set for the user's dealer has been exceeded.

Required sub-user rights: checkin_update.

Delete check-ins

post

/checkin/delete

Delete check-ins by ID.

Requires the checkin_update right, and a caller without it gets error 13. No security group grants that right. It follows from the fsm platform feature together with the checkin tariff feature on at least one tracker, so on an account with both every sub-user holds it, and on an account missing either nobody does, the master included.

Check-ins can therefore exist on an account that cannot delete them: checkin/create requires no right at all.

Also accepts GET with the same parameters as query-string values.

Authorizations

AuthorizationstringRequired

Body

checkin_idsinteger[]Required

IDs of the check-ins to delete.

Responses

200

Check-ins deleted

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

403

Error 13: the caller does not hold the checkin_update right.

application/json

default

Error response object

application/json

post/checkin/delete

POST /v2/checkin/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "checkin_ids": [
    1
  ]
}

{
  "success": true
}

Errors

These errors come in addition to the general error codes:

7 - Invalid parameters.
201 - Not found in the database - check-ins with the specified IDs don't exist, or their corresponding trackers are not available to current sub-user.

Required sub-user rights: checkin_update.

Create check-in

post

/checkin/create

Create a check-in. For exceptional cases only: check-ins normally come from the Mobile Tracker App.

To send a form with the check-in, create the form first with checkin/form/create and pass its ID in form_submission. Leave optional form fields out of values entirely rather than sending them empty.

Files come from checkin/image/create, whose returned IDs go in file_ids.

Authorizations

AuthorizationstringRequired

Body

tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

commentstringOptional

Optional. A comment on the check-in.

file_idsinteger[]Optional

Optional. IDs of files created with checkin/image/create.

Responses

200

The created check-in

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

idintegerOptional

ID of the new check-in.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/checkin/create

POST /v2/checkin/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "tracker_id": 1,
  "location": {
    "lat": 1,
    "lng": 1,
    "address": "text"
  },
  "comment": "text",
  "file_ids": [
    1
  ],
  "form_submission": {
    "form_id": 1,
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "success": true,
  "id": 1
}

Errors

These errors come in addition to the general error codes:

7 - Invalid parameters.
201 - Not found in the database - form with the specified IDs don't exist, or their corresponding trackers are not available to current sub-user.
242 - There were errors during content validation, if given values are invalid for the form.

Create check-in image

post

/checkin/image/create

Reserve a file for a check-in and return the credentials for uploading it.

This does not upload anything. It reserves space in the account's file quota and returns where and how to POST the file. Pass the returned file_id in checkin/create.

Leave a brief delay between uploads when sending several files.

Authorizations

AuthorizationstringRequired

Body

sizeinteger · min: 1Required

Maximum size in bytes of the file to be uploaded, used to reserve quota. The platform default cap is 16 MB.

filenamestringOptional

Optional. Name to give the uploaded file. Without it the name comes from the upload itself.

Responses

200

Where to upload the file

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

402

Error 268: the file cannot be created without violating the account's file quota. Error 271: size is above the maximum allowed, 16 MB by default.

application/json

default

Error response object

application/json

post/checkin/image/create

POST /v2/checkin/image/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "size": 1,
  "filename": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "success": true,
  "value": {
    "file_id": 1,
    "url": "text",
    "expires": "text",
    "file_field_name": "text",
    "fields": {
      "token": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Errors

These errors come in addition to the general error codes:

268 - File cannot be created due to quota violation.
271 - File size is larger than the maximum allowed (by default 16 MB).

How to upload file data

The upload target returned by checkin/image/create and checkin/form/file/create is used the same way in both cases. POST the file as multipart/form-data to the returned url, sending every entry of fields first and the file part last, named as file_field_name says.

With internal storage fields carries a single token. With Amazon S3 it carries policy, key, success_action_status, x-amz-algorithm, x-amz-credential, x-amz-date, x-amz-signature and x-amz-server-side-encryption, and each must be sent as its own form-data part before the file.

Create check-in form

post

/checkin/form/create

Create a form that can be sent with a check-in, and return its ID. A form is always created from a form template.

Pass the returned ID as form_submission.form_id in checkin/create.

Also accepts GET with the same parameters as query-string values.

Authorizations

AuthorizationstringRequired

Body

tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

template_idinteger · min: 1Required

ID of the form template to build the form from.

Responses

200

The created form

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

idintegerOptional

ID of the new form.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/checkin/form/create

POST /v2/checkin/form/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "tracker_id": 1,
  "template_id": 1
}

{
  "success": true,
  "id": 1
}

Errors

These errors come in addition to the general error codes:

201 - Not found in the database - if there is no template with such an ID.

Create check-in form file

post

/checkin/form/file/create

Reserve a file against a check-in form field and return the credentials for uploading it.

Give either checkin_id or form_id, not both. A request with neither reports a missing parameter named has_at_least_one_id_field, which is the internal name of the validation group rather than a parameter you can send; unusually for this API, it carries a readable message saying which two to choose between.

The upload works exactly as for checkin/image/create.

Leave a brief delay between uploads when sending several files.

Authorizations

AuthorizationstringRequired

Body

checkin_idinteger · min: 1Optional

ID of the check-in the form is attached to. Use this or form_id, not both.

form_idinteger · min: 1Optional

ID of the form. Use this or checkin_id, not both.

field_idstringRequired

ID of the form field the file attaches to. The field must be file-based.

sizeinteger · min: 1Required

Maximum size in bytes of the file to be uploaded, used to reserve quota. The platform default cap is 16 MB.

filenamestringOptional

Optional. Name to give the uploaded file. Without it the name comes from the upload itself.

Responses

200

Where to upload the file

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

402

Error 268: the file cannot be created without violating the account's file quota. Error 271: size is above the maximum allowed, 16 MB by default.

application/json

409

Error 267: six or more unsubmitted files are already associated with this form field.

application/json

default

Error response object

application/json

post/checkin/form/file/create

POST /v2/checkin/form/file/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "checkin_id": 1,
  "form_id": 1,
  "field_id": "text",
  "size": 1,
  "filename": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "success": true,
  "value": {
    "file_id": 1,
    "url": "text",
    "expires": "text",
    "file_field_name": "text",
    "fields": {
      "token": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Errors

These errors come in addition to the general error codes:

201 - Not found in the database - if there is no check-in with such an ID, or check-in doesn't have form, or form has no field with such a field_id.
231 - Entity type mismatch - if form field is not file-based, i.e. doesn't use file ID as its value.
267 - Too many entities - if there are 6 or more unsubmitted files already associated with this form's field.
268 - File cannot be created due to quota violation.
271 - File size is larger than the maximum allowed (by default 16 MB).

PreviousField service

NextDepartments

Last updated 1 month ago

Was this helpful?