Getting Started with conizi semantic models

The conizi semantic models describe all business objects that can be used on the conizi platform.

The original definition of these objects (models) was implemented with JSON Schema (Draft 6) and is still valid. You can get the JSON schema definition via Github.

The C# Models

In the course of the further development of conizi and the takeover of habbl and conizi by Daimler Fleetboard and the transfer to Fleetboard Logistics GmbH, it was decided to implement the semantic models in C# as well.

This enables TMS providers and customers, who rely on Microsoft's .NET Framework in their software, to easily integrate the models into their environment.

The library is divided into two parts:

  • The conizi semantic models in C# => Conizi.Model
  • A set of tools to deal with the models (generate, serialize, de-serialize...) => Conizi.Model.Core

You can get the library from two different Nuget packages:

New models and further developments are carried out exclusively in C#. The C# models can then be converted into JSON schemas or other possible formats.

It is also possible to generate a message from a C# model, which is then sent directly to conizi. The C# models are not only used to define the structure of the message (schema/model), but also to be the message itself.

Example for a simple tour-event

var m = new TourEvent
{
    TourId = "MyTourId",
    Receiver = new EdiMessageRouting
    {
        EdiId = "DAIMLER"
    },
    Network = new EdiNetwork
    {
        NetworkId = "FBL"
    },
    Tour = new EdiTourSpecificEvent
    {
        EventDateTime = DateTime.Now,
        TourAccepted = true
    }
}

Serialize the tour-event to JSON

With the help of the Conizi.Model.Core library, the C# models can be serialized to JSON.

var result =  Converter.Serialize(m);

Serialization result of the tour-event

{
   "$schema": "https://model.conizi.io/v1/transport/truck/groupage/forwarding/tour-event.json",
   "receiver": {
       "ediId": "DAIMLER"
   },
   "network": {
       "networkId": "FBL"
   },
   "tourId": "MyTourId",
   "tour": {
       "eventDateTime": "2019-04-24T18:07:05.5784106+02:00",
       "tourAccepted": true
   }
}

This serialized tour-event JSON message is ready to send to conizi Input HTTP API. Please have a look here, to get further information how the API works.

Further information

Heads up. If a connection in the habbl context is developed by the customer himself, please clarify with the responsible consultant on Fleetboard Logistics which Ids should be used as sender in multiple cases.

In the following some scenarios are listed, which should help in working with conizi.

More examples can be found here