Versions Compared

Old Version 1

changes.mady.by.user Jürgen Strauss

Saved on

compared with

New Version 2

changes.mady.by.user Andrin Portmann

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DeliveryPath = api/v1.0/Core/VinX/Delivery/

Driver

GET on {DeliveryPath}/Driver

Global Filters

Filter

Query

Notes

Only drivers which were already assigned to a delivery

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id": "1880",
    "FirstName": "Otto",
    "LastName": "von Bismarck",
    "Shortname": "OVB"
  }
]

Vehicle

GET on {DeliveryPath}/Vehicle

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id" : 2,
    "Description" : "MAN TGL",
    “Plate”: “FR 10001”,
    “MinWeightInTons”: 10,
    “MaxWeightInTons”: 19.9,
  },
  {
    "Id" : 3,
    "Description" : "MAN TGL",
    “Plate”: “FR 10002”,
    “MinWeightInTons”: 10,
    “MaxWeightInTons”: 19.9,
  }
]

Tour

GET on {DeliveryPath}/Tour

Enum DeliveryDays

Name

Value

NoDelivery

0

Morning

10

Afternoon

20

WholeDay

30

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id" : 1,
    "Description" : "Lausanne Est: Vevey, Montreux et Valais",
    "Designation" : "Lausanne Est",
    "Number”: 12,
    “VehicleId”: 1,
    “Monday”: 10,
    “Tuesday”: 0,
    “Wednesday”: 10,
    “Thursday”: 0,
    “Friday”: 30,
    “Saturday”: 0
  }
]

Package

GET on {DeliveryPath}/Package

Global Filters

Filter

Query

Notes

ArticleType

Artikeltyp = 1

Return

Retourenanzeige = true

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id": 8823,
    "Number": 1088,
    "Description": "Vini 24-er (24x.-30), Fr. 7.20"
  }
]

Deliveries Read

GET on {DeliveryPath}

Global Filters

Filter

Query

Notes

not closed

Status < ??

in the future

StartZeit >= Today

Enum State

Name

Value

Open

10

Fixed

20

Printed

30

InDelivery

50

Delivered

60

Archived

100

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id": 1,
    "TourId": 5,
    "VehicleId": 1,
    "DriverId": 12,
    "State": "Fixed",
    "Date": "2024-10-13T00:00:00",
    "Timing": "Morning",
    "Stations": [
      {
        "Position": 1,
        "Address": {
          "Id": 6656,
          "Number": 123455,
          "Name": "Hotel & Taverne zum alten Löwen",
          "Street": "Zugstrasse 9",
          "City": "Zürich",
          "Zip": 8006,
          "Email": "hotel@alten-loewen.ch",
          "NotifyByTelephone": true,
        },
        "Receipt": {
          "Id": 1324,
          "Number": 1245235,
          "Remarks": "Lieferung über den Hinterausgang",
          "Type": "Lieferschein",
          "Contact": {
            "FirstName": "Franz",
            "LastName": "Ferdinand",
            "Telephone": "+417800000000",
            "Mobile": "+417900000000",
            "Email": "franz.ferdinand@kuk.at"
          },
          "Positions": [
            {
              "Id": 124154,
              "PositionOnReceipt": 1,
              "ArticleId": 32513245,
              "ArticleNumber": 1241242,
              "Description": "Moët & Chandon ICE Impérial netto",
              "Quantity": 12,
              "QuantityPackage": 2,
              "Filling": "150cl EW (150cl EW)",
              "Package": "6er Kart"
            }
          ],
          "Packages": [
            {
              "Id": 1234561,
              "Number": 1234561,
              "QuantityDelivered": 1,
              "QuantityReturned": 4
            }
          ]
        }
      }
    ]
  }
]

Deliveries Write

Post on {DeliveryPath}

Field name

Data type

Field VinX

Notes

Id

number

Auslieferung_ID

If Id is null a new delivery gets created.

TourId

number

Auslieferung_TourID

VehicleId

number

Auslieferung_FahrzeugID

DriverId

number

Auslieferung_ChauffeurID

State

enum State

Auslieferung_Status

Date

Date

 Auslieferung_Datum

 

Timing

enum DeliveryDays

 Auslieferung_Zeitpunkt

Morning, afternoon, whole day

Stations

array

If stations array is empty the delivery gets deleted.

.. Position

number

Station_Position

delivery sequence

.. Receipt

object

../.. Id

number

Bel_ID

../.. Packages

array

incremental

Is used for return of packages.

../../.. Id

number

GebPos_ArtikelID

../../.. QuantityReturned

number

GebPos_Retour

if already exists value gets replaced

...

Expand
titleExample Response
Code Block
languagejson
[
  {
    "Id": 1,
    "TourId": 5,
    "VehicleId": 1,
    "DriverId": 12,
    "State": "Fixed",    
    "Date": "2024-10-13T00:00:00",
    "Timing": "Morning",
    "Stations": [
      {
        "Position": 1,
        "Address": {
          "Id": 6656,
          "Number": 123455,
          "Name": "Hotel & Taverne zum alten Löwen",
          "Street": "Zugstrasse 9",
          "City": "Zürich",
          "Zip": 8006,
          "Email": "hotel@alten-loewen.ch",
          "NotifyByTelephone": true,
        },
        "Receipt": {
          "Id": 1324,
          "Number": 1245235,
          "Remarks": "Lieferung über den Hinterausgang",
          "Type": "Lieferschein",
          "Contact": {
            "FirstName": "Franz",
            "LastName": "Ferdinand",
            "Telephone": "+417800000000",
            "Mobile": "+417900000000",
            "Email": "franz.ferdinand@kuk.at"
          },
          "Positions": [
            {
              "Id": 124154,
              "PositionOnReceipt": 1,
              "ArticleId": 32513245,
              "ArticleNumber": 1241242,
              "Description": "Moët & Chandon ICE Impérial netto",
              "Quantity": 12,
              "QuantityPackage": 2,
              "Filling": "150cl EW (150cl EW)",
              "Package": "6er Kart"
            }
          ],
          "Packages": [
            {
              "Id": 1234561,
              "Number": 1234561,
              "QuantityDelivered": 1,
              "QuantityReturned": 4
            }
          ]
        }
      }
    ]
  }
]

Media

Post on {DeliveryPath}/receipt/{id}/media

...