API Changelog

2.4.47

  • Introduce verify_email action to /users/ API to verify user email
  • Introduce new validation rule to validate phone numbers in notifications

2.4.46

  • Introduce hijack action to /users/ API to hijack user account

2.4.45

  • Introduce custom API AccessToken to replace it with default Token used
  • Add new API /logout/ to logout and revoke token

2.4.44

  • Metafields: added field show_in_form

2.4.43

  • Metafields: added value_type assignee

2.4.42

  • Configuration defaults has transit_active_limit

2.4.40

  • Metafields: added value_type link

2.4.39

  • Task restart action to restart a task from failed state

2.4.38

  • Expose a read-only feature_tracker_url under Account

2.4.37

  • Expose optimize_return_to_depot, optimize_earliest_start, optimize_latest_end under AccountRole

2.4.36

  • Orders: added field recurrence
  • Tasks: added fields recurrence and calendar_time
  • Tasks: added states draft and scheduled

2.4.35

  • Tracker added fields show_last_task_event_notes, show_last_task_images, last_task_event_notes, last_task_images

2.4.34

  • RouteOptimizationResultTask: added field reference

2.4.33

  • Documents: added field recurrence
  • Orders: added field recurrence
  • Orders: added sideloading option recurrence__documents
  • Tasks: added field recurrence
  • Tasks: added sideloading option recurrence__documents
  • Recurrences: removed field order and added fields order_data, route

2.4.32

  • All endpoints: added list view query argument names validation

2.4.31

  • Recurrences: added field external_id

2.4.30

  • AccountRole: add detail action resend_activation_token to resend activation token to the user

2.4.29

  • Tasks: added field created_by

2.4.28

  • Configuration: Added features signature_required_task_category and picture_required_task_category which limit the signature and picture requirement based on task category
  • Documents: added write-only field s3_response_headers
  • Signatures: added field external_id and write-only field s3_response_headers

2.4.27

  • Tasks: Add detail action pod to get HTML or PDF via API

2.4.26

  • Documents: Added file_upload content check when creating documents (rescinded)
  • Signatures: Added file_upload content check when creating signatures (rescinded)

2.4.25

  • Route Optimization: Add detail action report to get HTML or PDF reports via API

2.4.24

  • Configuration: Added features signer_name_required and notes_required

2.4.23

  • Configuration: Added features signer_name_required and notes_required
  • TimeLocations: Added fields is_moving, event and activity_type

2.4.22

  • Webhook: Rename state disabled to failed, rename disabled_at to failed_at and disable_message to fail_message

2.4.21

  • Account: add field review_emails_to_assignee to API

2.4.20

  • FormRule: added field open_in
  • TaskForm: added field open_in

2.4.19

  • Tracker: Rename field predicted_delivery_at to predicted_delivery_calculated_at in order to avoid confusion

2.4.18

  • Account: add fields route_default_state and feature_route_auto_archive to model and API
  • Configuration: add field create_contact_address to configuration defaults
  • Route: add field state to model and API
  • Route: API add actions activate, archive and draft

2.4.17

  • Add Accept-Timezone header in order to manage timezones correctly. Can be used retrospectively.
  • Account: add feature flag feature_route_folders to allow tasks to be grouped into routes in the WEB dashboard.
  • Configuration: add field create_contact_address to configuration defaults
  • Configuration: remove feature reposition_icon
  • Routes: add fields name and objective to Route model and API
  • Routes: Replaced fields start_location and end_location with start_address and end_address
  • RouteOptimizations: Add end_time to RouteOptimization model and API
  • Tasks: add field routes to Tasks sideloading
  • TasksCommand: add field route to TaskCommand.task_data if you need to update/assign/reassign/unassign the task

2.4.16

  • Tracker: Added field predicted_delivery_error to Tracker Public detail view

2.4.15

  • Tasks: fields contact_address and contact_address_external_id made visible
  • Tasks: Added filters for contact_address and contact_address__external_id

2.4.14

  • TaskCommand: contact_address.address added to task_data as an updatable field in order to

allow updating contact_address.address data for future usage

2.4.13

  • Tasks: updated_at_delay_latest filter added
  • NB! Web and Mobile apps should use this filter as it replaces older logic applied

for cases where updated_at__gt or updated_at__gte filtering is used without an upper bound. This filter prevents the out-of-order appearance of records. Implemented for the following views: scenes_dashboard, scenes_task_list, task_exports and tasks list views

2.4.12

  • Tasks: contact_address write only field added
  • Tasks: contact_address_external_id write only field added
  • contact_address will replace missing address and/or contact values when in POST and PUT requests

2.4.11

  • Accounts: optimize_when_on_duty removed

2.4.10

  • Recurrences: scheduled_time added to tasks_data

2.4.9

  • Recurrences: assignee is not based on user instead of account_role to match other assignee usages

2.4.8

  • NotificationTemplate: Add field phones to API
  • NotificationTemplate: Add field emails to API

2.4.7

  • TaskBackgroundImport: Add field order_orderer to API
  • TaskBackgroundImport: Field contact_accress_external_id is now saved to task for future reference
  • TaskExport: Add contact_accress_external_id as an exportable field
  • Task: Add contact_accress relation to database as a reference
  • Orders are now generated with orderer data in case order_orderer is set during import

2.4.6

  • Remove assignee from OrderSerializerV2

2.4.5

  • TasksStatesCount: Add filter assignee__in to API
  • TasksStatesCount: assignee filters are now based on user_id instead of account_role_id to match other endpoints
  • TasksStatesCount: drop assignee_url from response data

2.4.4

  • Add billing for ConfigurationSerializer

2.4.3

  • Sideloaded orders serializer changed to OrdersV2Serializer for tasks endpoint

2.4.2

  • Added Documents batch delete action
  • Added Signatures batch delete action

2.4.1

  • Added AccountRole activation API
  • Added user activation API

2.4.0

  • Added AccountRole rolling window tasks scheduling
  • Added rolling window schedule based notifications

2.3.5

  • Metafields API active usage removed from queryset to allow admins to see and edit non-visible metafields
  • Better error handling in case metafield is not editable.

2.3.4

  • Recurrence: Dropped field assign_worker from API
  • Recurrence: Added field assignee to API
  • Recurrence: Added field created_by to API

2.3.3

  • Order: Added field description to API

2.3.2

  • Document: Added field mimetype and thumbnail to API
  • Signature: Added field mimetype and thumbnail to API
  • Document and Signature: mimetype detection added and thumbnail generation added

2.3.1

  • OrdersAPI: Added field documents

2.3.0

  • Task: position field changed to Float in the backend
  • TaskBackgroundImport: version field added to denote, what API version was used to create the import and what version to use the serialize the tasks_data
  • TaskImportSerializerV2: position expects timestamp as a float value
  • RouteOptimizationSerializerV1: position expects timestamp as a float value
  • RouteOptimizationResultSerializer: position expects timestamp as a float value
  • TODO!

2.2.6

  • Documentation update: Custom filters added to documentation
  • Schema update: Due to Changes in documentation, schema has updated

2.2.5

  • TasksBackgroundImport: API exposed.
  • TaskBackgroundImport: version field added to denote, what API version was used to create the import and what version to use the serialize the tasks_data
  • TasksBackgroundImport and TasksImport: assignee name matching based on account_role.display_name instead of user.get_full_name()

2.2.4

  • RouteOptimization: Added field errors to API

2.2.3

  • Task: Add filter UUID filter task_import
  • Task: Add filter Datetime filters address__geocoded_at and address__geocode_failed_at

2.2.2

  • Address: Added field geocoded_at
  • Address: Added field geocode_failed_at
  • Address: Dropped field geocode_failure_notified_at
  • RouteOptimization: Added fields commited_at, scheduled_at, started_at, ready_at, completed_at, failed_at to API
  • TaskCommand: Added field address as an updatable field

2.2.1

  • TaskExports: Account filter is required
  • TaskExports: requested field names are checked and raise error if invalid.
  • TaskExports: New export serializer

2.2.0

  • TaskCommands: metafields and other data sent for task update will be sent to field task_data

2.1.1

  • TODO

2.1.0

  • ContactAddressExportPermissions endpoint added
  • ReviewPermission endpoint added
  • Order endpoint: Tasks data must be posted to tasks_data field

2.0.0

  • TODO

1.1.0

  • TODO

1.0.0

  • TODO