🖍️
Dataloy VMS API Documentation
API Release 8.5
API Release 8.5
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Release 8.5
      • Release 8.0
      • Release 7.3 - 7.12
      • Release 7.0 - 7.2
      • Release 6.29 - 6.46
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. User Guides
  2. Enterprise functionalities

Websockets

PreviousAlert ScriptsNextBulk Deletion

Was this helpful?

Build interactive HTML 5 application using Dataloy Websockets.

It is possible to open a Websocket to get notified when there are changes in Dataloy data model.

The concept is very similar to Webhooks, it is possible open a socket to be notified for Creation, Update and Deletion of any of object type of the data model.

The endpoint syntax is:

  • ws://{url}/ws/rest/WebSocketObjectSubscription/{objectType}/{eventType}/{key}/{token}

The JSON pushed will have the same structure of the one pushed by Webhooks.

It is possible to customize the JSON sent from the Server to the Client using .

(The JSON fields can be sent through the open Websocket by the Client to the Server)

(To get back to the standard fields list a empty JSON ( {} ) can be sent from the client to the server)

It is possible to open a Websocket linked to an Alert Script to be notified when the script is fired and returns true.

The endpoint to use is:

  • ws://{url}/ws/rest/WebSocketAlertScript/{scriptCode}/{token}

Passing the script code.

Adjust Number of Fields to be Returned from a Request