Skip to content

Vehicle service task

API path: /vehicle/service_task.

Task status

Task status may be one of:

  • created – initial state of task.
  • notified – one of conditions exceed notification limit.
  • expired – one of conditions exceeded.
  • done – user set task as "done".

batch_create

Creates multiple service tasks.

parameters

name description type
vehicle_ids List of vehicle ids. Task will be created for every vehicle. array of int
task Service task to create. vehicle_id field in these objects should not be specified. JSON object

A task object is:

{
    "description": "Service task",
    "comment": "",
    "cost": 10050.0000,
    "conditions": {
        "mileage": {
            "limit": 100,
            "notification_interval": 10
        },
        "date": {
            "end": "2015-05-08 09:35:00",
            "notification_interval": 3
        },
        "engine_hours": {
            "limit": 100,
            "notification_interval": 10
        }
    },
    "notifications": {
        "sms_phones": [
            "79221234567",
            "79227654321"
        ],
        "emails": [
            "[email protected]",
            "[email protected]"
        ],
        "push_enabled": true
    },
    "repeat": false,
    "unplanned": false,
    "file_ids": [1, 2]
}
  • description - string. Name of a service task. Max 255 characters.
  • comment - string. Comment for a task. Max 255 characters.
  • cost - float. Cost in the currency of the user. For information only.
  • conditions - task end conditions. At least one of fields ("mileage" or "date" or "engine_hours") must be passed.
    • mileage - optional object. Mileage condition.
      • limit - int. Task limit in kilometers.
      • notification_interval - int. Notify about task in specified number of kilometers.
    • date - optional date condition object.
      • end - string date/time. Task end date.
      • notification_interval - int. Notify about task in specified number of days.
    • engine_hours - optional engine hours condition object.
      • limit - int. Task limit in hours.
      • notification_interval - int. Notify about task in specified number of hours.
  • notifications - notifications object.
    • sms_phones - array of string. Phones where sms notifications should be sent. In the international format without + sign.
    • emails - array of string. Email addresses where sms notifications should be sent.
    • push_enabled - boolean. If true push notifications enabled.
  • repeat - boolean. If true then new task will be created when current task done.
  • unplanned - boolean. If true service task is unplanned. For information only.
  • file_ids - array of int. One file will be specified in many service tasks. If one of the tasks will be deleted, then file will remain in others. File will be deleted only when the last task with it will be deleted.

example

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/batch/create' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "vehicle_ids": [76801, 76449], "task": {"comment": "", "conditions": {"date": {"end": "2020-12-10 23:59:59", "notification_interval": 3}}, "cost": 100, "description": "service1", "file_ids": [], "notifications": {"sms_phones": [], "emails": [], "push_enabled": true}, "repeat": false, "unplanned": false}'

response

{"success":true}

create

Creates a new vehicle service task. For vehicles with associated tracker only.

parameters

name description type
task Service task to create. JSON object

A task object is:

{
    "vehicle_id": 222,
    "description": "Service task",
    "comment": "",
    "cost": 10050.0000,
    "conditions": {
        "mileage": {
            "limit": 100,
            "notification_interval": 10
        },
        "date": {
            "end": "2015-05-08 09:35:00",
            "notification_interval": 3
        },
        "engine_hours": {
            "limit": 100,
            "notification_interval": 10
        }
    },
    "notifications": {
        "sms_phones": [
            "79221234567",
            "79227654321"
        ],
        "emails": [
            "[email protected]",
            "[email protected]"
        ],
        "push_enabled": true
    },
    "repeat": false,
    "unplanned": false,
    "file_ids": [1, 2]
}
  • vehicle_id - int. An id of associated vehicle.
  • description - string. Name of a service task. Max 255 characters.
  • comment - string. Comment for a task. Max 255 characters.
  • cost - float. Cost in the currency of the user. For information only.
  • conditions - task end conditions. At least one of fields ("mileage" or "date" or "engine_hours") must be passed.
    • mileage - optional object. Mileage condition.
      • limit - int. Task limit in kilometers.
      • notification_interval - int. Notify about task in specified number of kilometers.
    • date - optional date condition object.
      • end - string date/time. Task end date.
      • notification_interval - int. Notify about task in specified number of days.
    • engine_hours - optional engine hours condition object.
      • limit - int. Task limit in hours.
      • notification_interval - int. Notify about task in specified number of hours.
  • notifications - notifications object.
    • sms_phones - array of string. Phones where sms notifications should be sent. In the international format without + sign.
    • emails - array of string. Email addresses where sms notifications should be sent.
    • push_enabled - boolean. If true push notifications enabled.
  • repeat - boolean. If true then new task will be created when current task done.
  • unplanned - boolean. If true service task is unplanned. For information only.
  • file_ids - array of int. One file will be specified in many service tasks. If one of the tasks will be deleted, then file will remain in others. File will be deleted only when the last task with it will be deleted.

example

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/create' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "task": {"vehicle_id": 76801, "comment": "", "conditions": {"date": {"end": "2020-12-10 23:59:59", "notification_interval": 3}}, "cost": 100, "description": "service1", "file_ids": [], "notifications": {"sms_phones": [], "emails": [], "push_enabled": true}, "repeat": false, "unplanned": false}'

response

{
  "success":true,
  "id": 33777
}
  • id - int. An id of created task.

errors

  • 201 (Not found in the database) – vehicle or tracker not found.
  • 214 (Requested operation or parameters are not supported by the device) – engine hours condition passed but tracker hasn't ignition sensor.

delete

Deletes a vehicle service task.

parameters

name description type
task_id Optional. Id of service task. int
task_ids Optional. Ids of service tasks. array of int

Either task_id or task_ids should be specified

examples

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/delete' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "task_id": 33777}'
https://api.navixy.com/v2vehicle/service_task/delete?hash=a6aa75587e5c59c32d347da438505fc3&task_id=33777

response

{ "success": true }

download

Creates pdf report of service tasks.

parameters

name description type
order_by Sort option. Possible values listed below string enum
ascending Optional. Default is true. Sort direction. boolean
group_by Optional. Group by option. Can be "vehicle" or "status" string enum
  • order_by possible values:
    • "vehicle" - order by vehicle_id.
    • "description" - order by description.
    • "status" - order by status.
    • "cost" - order by cost.

examples

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/download' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "order_by": "vehicle", "group_by": "status"}'
https://api.navixy.com/v2vehicle/service_task/download?hash=a6aa75587e5c59c32d347da438505fc3&order_by=vehicle&group_by=status

response

Report file.

list

List all service tasks of all user vehicles.

parameters

name description type
return_prediction Include legacy prediction field or not boolean

examples

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "return_prediction": "false"}'
https://api.navixy.com/v2vehicle/service_task/list?hash=a6aa75587e5c59c32d347da438505fc3&return_prediction=false

response

{
    "success": true,
    "list": [
        {
            "id": 725,
            "vehicle_id": 222,
            "vehicle_label": "AGV",
            "status": "created",
            "prediction": {
                "end_date": "2015-05-03 09:35:00",
                "wear_percentage": 40
            },
            "description": "Service task",
            "cost": 10050.0,
            "completion": {
                "mileage": 31,
                "date": "2014-03-16 00:00:00",
                "engine_hours": 140
            },
            "completion_date" : "2014-03-16 00:00:00",
            "conditions": { 
                "mileage": {
                    "limit": 100,
                    "notification_interval": 10
                },
                "date": {
                    "end": "2015-05-08 09:35:00",
                    "notification_interval": 3
                },
                "engine_hours": {
                    "limit": 100,
                    "notification_interval": 10
                }
            },
            "current_position": {
                "mileage": 11,
                "date": "2012-03-06 15:55:03",
                "engine_hours": 100
            },
            "start": {
                "mileage": 1230,
                "date": "2015-05-01 17:46:44",
                "engine_hours": 50
            },
            "repeat": false,
            "unplanned": false,
            "file_ids": [2, 3]
        }
    ]
}
  • id - int. An id of created task.
  • vehicle_label - string. Vehicle label.
  • status - string enum. Status.
  • prediction - optional object. Legacy field, is not used anymore. check return_prediction parameter.
    • end_date - string date/time. Predicted end date.
    • wear_percentage - int. Wear percentage.
  • completion - object. Date and counter's values when the task marked as done. Non-editable.
  • completion_date - string date/time. Date when a service task completed.
  • current_position - object. Current position values.
    • mileage - int. Current mileage.
    • date - string date/time. Current date.
    • engine_hours - int. Current engine hours.
  • start - object. Consists initial values.
    • mileage - int. Initial odometer value for tasks with mileage condition.
    • date - string date/time. Task creation date for tasks with date condition.
    • engine_hours - int. Initial engine hours value for tasks with engine hours condition.
  • vehicle_id - int. An id of associated vehicle.
  • description - string. Name of a service task. Max 255 characters.
  • comment - string. Comment for a task. Max 255 characters.
  • cost - float. Cost in the currency of the user. For information only.
  • conditions - task end conditions. At least one of fields ("mileage" or "date" or "engine_hours") must be passed.
    • mileage - optional object. Mileage condition.
      • limit - int. Task limit in kilometers.
      • notification_interval - int. Notify about task in specified number of kilometers.
    • date - optional date condition object.
      • end - string date/time. Task end date.
      • notification_interval - int. Notify about task in specified number of days.
    • engine_hours - optional engine hours condition object.
      • limit - int. Task limit in hours.
      • notification_interval - int. Notify about task in specified number of hours.
  • notifications - notifications object.
    • sms_phones - array of string. Phones where sms notifications should be sent. In the international format wo + sign.
    • emails - array of string. Email addresses where sms notifications should be sent.
    • push_enabled - boolean. If true push notifications enabled.
  • repeat - boolean. If true then new task will be created when current task done.
  • unplanned - boolean. If true service task is unplanned. For information only.
  • file_ids - array of int. One file will be specified in many service tasks. If one of the tasks will be deleted, then file will remain in others. File will be deleted only when the last task with it will be deleted.

About task status property.

errors

  • 201 (Not found in the database) – vehicle or tracker not found.

read

Get service task info by its id.

parameters

name description type
task_id Id of service task. int
return_prediction Include legacy prediction field or not boolean

examples

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/read' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "task_id": 37577, "return_prediction": "false"}'
https://api.navixy.com/v2vehicle/service_task/read?hash=a6aa75587e5c59c32d347da438505fc3&task_id=37577&return_prediction=false

response

{
    "success": true,
    "value": {
        "id": 725,
        "vehicle_id": 222,
        "status": "created",
        "prediction": {
            "end_date": "2015-05-03 09:35:00",
            "wear_percentage": 40
        },
        "description": "Service task",
        "comment": "",
        "cost": 100500.0,
        "completion": {
            "mileage": 31,
            "date": "2014-03-16 00:00:00",
            "engine_hours": 140
        },
        "conditions": {
            "mileage": {
                "limit": 100,
                "notification_interval": 10
            },
            "date": {
                "end": "2015-05-08 09:35:00",
                "notification_interval": 3
            },
            "engine_hours": {
                "limit": 100,
                "notification_interval": 10
            }
        },
        "start": {
            "mileage": 1230,
            "date": "2015-05-01 17:46:44",
            "engine_hours": 50
        },
        "notifications": {
            "sms_phones": [
                "79221234567",
                "79227654321"
            ],
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "push_enabled": true
        },
        "completion_date" : "2014-03-16 00:00:00",
        "repeat": false,
        "unplanned": false,
        "file_ids": [1, 2]
    },
    "files": [<file_object>]
}

All parameters described in a list method.

errors

  • 201 (Not found in the database) – does not exist one of tracker's counters which required to determine status.
  • 204 (Entity not found) – when vehicle or service task not found.

set_status

Updates task status, snd saved (on done status) current date and values of used (in condition) counters for "freeze" wearing percent.

parameters

name description type
task_id Id of service task. int
status A new task status. Only done status allowed for now. string enum

examples

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/set_status' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "task_id": 37577, "status": "done"}'
https://api.navixy.com/v2vehicle/service_task/set_status?hash=a6aa75587e5c59c32d347da438505fc3&task_id=37577&status=done

response

{ "success": true }

errors

  • 201 (Not found in the database) – does not exist one of tracker's counters which required to determine status.
  • 204 (Entity not found) – when vehicle or service task not found.

update

Updates information fields and notification settings of vehicle service task.

parameters

name description type
task Service task to create. JSON object

A task object described in a task create.

example

curl -X POST 'https://api.navixy.com/v2vehicle/service_task/update' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "task": {"vehicle_id": 76801, "comment": "", "conditions": {"date": {"end": "2020-12-10 23:59:59", "notification_interval": 3}}, "cost": 100, "description": "service1", "file_ids": [], "notifications": {"sms_phones": [], "emails": [], "push_enabled": true}, "repeat": false, "unplanned": false}'

response

{ "success": true }

errors

  • 204 (Entity not found) – when vehicle or service task not found.
  • 214 (Requested operation or parameters are not supported by the device) – engine hours condition passed but tracker hasn't ignition sensor.

Last update: November 25, 2020