HELIUM V REST API: ForecastApi

GET /api/v1/forecast/deliveryaddress/list

Liefert eine Liste aller Forecastlieferadressen

Request Parameters
name	type	description	constraints
filter_deliverable	query	mit `true` nur jene mit lieferbaren Positionen	boolean
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	ForecastDeliveryAddressEntryList (JSON)	eine (leere) Liste von Forecastlieferadressen entsprechend den Filterkriterien
application/xml;charset=UTF-8	object

Example

Request

GET /api/v1/forecast/deliveryaddress/list
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "forecastId" : 12345,
    "customerId" : 12345,
    "deliveryAddress" : "...",
    "pickingType" : "ITEM",
    "deliveryAddressShort" : "...",
    "pickingPrinterCnr" : "...",
    "id" : 12345
  }, {
    "forecastId" : 12345,
    "customerId" : 12345,
    "deliveryAddress" : "...",
    "pickingType" : "ADDRESS",
    "deliveryAddressShort" : "...",
    "pickingPrinterCnr" : "...",
    "id" : 12345
  } ]
}

GET /api/v1/forecast/linecall/{linecallid}

Einen Linenabruf anhand seiner Id ermitteln

Request Parameters
name	type	description	constraints
linecallid	path	Id des gesuchten Linienabrufs	int
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	LinecallEntry (JSON)	den Linienabruf sofern vorhanden, gibt es den Linienabruf nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet
application/xml;charset=UTF-8	object

Example

Request

GET /api/v1/forecast/linecall/{linecallid}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "quantity" : 12345.0,
  "line" : "...",
  "sector" : "...",
  "sectorDescription" : "...",
  "productionDateMs" : 12345,
  "ordernumber" : "...",
  "linecallItemEntries" : [ {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "openQuantity" : 12345.0
  }, {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "openQuantity" : 12345.0
  } ],
  "id" : 12345
}

POST /api/v1/forecast/linecall/{linecallid}

Erzeugt eine Ausgabe eines Artikels des Linienabrufs

Wurde die Produktion über die Resource /material/{positionid}/delivery noch nicht gestartet, wird mit StatusCode BAD_REQUEST (400) geantwortet

Request Parameters
name	type	description	constraints
linecallid	path	Id des Linienabrufs, gibt es den Linienabruf nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int

Request Body
media type	data type
application/json	LinecallDeliveryPostEntry (JSON)
application/xml;charset=UTF-8	object

Response Body
media type	data type	description
application/json	LinecallDeliveryResultEntry (JSON)	ein ResultEntry mit der noch offenen Menge
application/xml;charset=UTF-8	object	ein ResultEntry mit der noch offenen Menge

Example

Request

POST /api/v1/forecast/linecall/{linecallid}
Content-Type: application/json
Accept: application/json

                
{
  "userId" : "...",
  "itemId" : 12345,
  "quantity" : 12345.0,
  "pickingType" : "NOTINITIALIZED"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "linecallId" : 12345,
  "itemId" : 12345,
  "openQuantity" : 12345.0
}

POST /api/v1/forecast/material/{positionid}

Request Parameters
name	type	constraints
positionid	path	int
filter_pickingtype	query	"ADDRESS" or "CALLOFF" or "ITEM" or "NOTINITIALIZED"
userid	query

Example

Request

POST /api/v1/forecast/material/{positionid}
Content-Type: */*

                
...

Response

HTTP/1.1 201 Created

GET /api/v1/forecast/pickingprinter/list

Liefert eine Liste aller definierten Drucker der Kommissionierung

Request Parameters
name	type	description
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	PickingPrinterEntryList (JSON)	eine (leere) Liste aller Kommissionierdrucker
application/xml;charset=UTF-8	object	eine (leere) Liste aller Kommissionierdrucker

Example

Request

GET /api/v1/forecast/pickingprinter/list
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "description" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "description" : "...",
    "id" : 12345
  } ]
}

GET /api/v1/forecast/position/list

Liefert eine Liste aller Forecastpositionen

Request Parameters
name	type	description	constraints
filter_deliverable	query	mit `true` nur lieferbare Positionen	boolean
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	ForecastPositionEntryList (JSON)	eine (leere) Liste von Forecastpositionen entsprechend den Filterkriterien
application/xml;charset=UTF-8	object

Example

Request

GET /api/v1/forecast/position/list
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "dateMs" : 12345,
    "ordernumber" : "...",
    "linecallEntries" : [ {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    }, {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    } ],
    "staffId" : 12345,
    "staffDescription" : "...",
    "productionCnr" : "...",
    "productType" : "PICKING",
    "id" : 12345
  }, {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "dateMs" : 12345,
    "ordernumber" : "...",
    "linecallEntries" : [ {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    }, {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    } ],
    "staffId" : 12345,
    "staffDescription" : "...",
    "productionCnr" : "...",
    "productType" : "STOCK",
    "id" : 12345
  } ]
}

GET /api/v1/forecast/position/{positionid}

Eine Forecastposition anhand seiner Id ermitteln

Request Parameters
name	type	description	constraints
positionid	path	Id der gesuchten Forecastposition	int
filter_deliverable	query		boolean
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	ForecastPositionEntry (JSON)	die Forecastposition sofern vorhanden, gibt es die Forecastposition nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet
application/xml;charset=UTF-8	object

Example

Request

GET /api/v1/forecast/position/{positionid}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "itemEntry" : {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  },
  "quantity" : 12345.0,
  "dateMs" : 12345,
  "ordernumber" : "...",
  "linecallEntries" : [ {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  }, {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  } ],
  "staffId" : 12345,
  "staffDescription" : "...",
  "productionCnr" : "...",
  "productType" : "PICKING",
  "id" : 12345
}

POST /api/v1/forecast/position/{positionid}

Erzeugt eine Ausgabe eines Artikels der Forecastposition

Wurde die Produktion über die Resource /material/{positionid}/delivery noch nicht gestartet, wird mit StatusCode BAD_REQUEST (400) geantwortet

Request Parameters
name	type	description	constraints
positionid	path	Id der Forecastposition, gibt es die Forecastposition nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int

Request Body
media type	data type
application/json	LinecallDeliveryPostEntry (JSON)
application/xml;charset=UTF-8	object

Response Body
media type	data type	description
application/json	ForecastPositionEntry (JSON)	die Forecastposition mit den veränderten Mengen
application/xml;charset=UTF-8	object	die Forecastposition mit den veränderten Mengen

Example

Request

POST /api/v1/forecast/position/{positionid}
Content-Type: application/json
Accept: application/json

                
{
  "userId" : "...",
  "itemId" : 12345,
  "quantity" : 12345.0,
  "pickingType" : "CALLOFF"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "itemEntry" : {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  },
  "quantity" : 12345.0,
  "dateMs" : 12345,
  "ordernumber" : "...",
  "linecallEntries" : [ {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  }, {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  } ],
  "staffId" : 12345,
  "staffDescription" : "...",
  "productionCnr" : "...",
  "productType" : "PICKING",
  "id" : 12345
}

GET /api/v1/forecast/material/{positionid}/delivery

Liefert die zur Forecastposition zugehörigen Linienabrufe, mitsamt den zu liefernden Materialien

Request Parameters
name	type	description	constraints
positionid	path	Id der Forecastposition, gibt es die Forecastposition nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	LinecallEntryList (JSON)	Liste der Linienabrufe
application/xml;charset=UTF-8	object	Liste der Linienabrufe

Example

Request

GET /api/v1/forecast/material/{positionid}/delivery
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  }, {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  } ]
}

POST /api/v1/forecast/material/{positionid}/delivery

Startet die Produktion eines Positionsartikels

Request Parameters
name	type	description	constraints
positionid	path	Id der Forecastposition, gibt es die Forecastposition nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	ForecastPositionEntry (JSON)	Forecastposition mit den zu liefernden Materialien
application/xml;charset=UTF-8	object	Forecastposition mit den zu liefernden Materialien

Example

Request

POST /api/v1/forecast/material/{positionid}/delivery
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "itemEntry" : {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  },
  "quantity" : 12345.0,
  "dateMs" : 12345,
  "ordernumber" : "...",
  "linecallEntries" : [ {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  }, {
    "quantity" : 12345.0,
    "line" : "...",
    "sector" : "...",
    "sectorDescription" : "...",
    "productionDateMs" : 12345,
    "ordernumber" : "...",
    "linecallItemEntries" : [ {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    }, {
      "itemEntry" : { },
      "quantity" : 12345.0,
      "openQuantity" : 12345.0
    } ],
    "id" : 12345
  } ],
  "staffId" : 12345,
  "staffDescription" : "...",
  "productionCnr" : "...",
  "productType" : "STOCK",
  "id" : 12345
}

GET /api/v1/forecast/position/{positionid}/printdispatchlabel

Ein Versandetikett zu einer sich in Produktion befindlichen Forecastposition als JRPrint erhalten.

Request Parameters
name	type	description	constraints
positionid	path	Id der Forecastposition, gibt es die Forecastposition nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	object (JSON)	Versandetikett als JRPrint
application/xml	anyType (XML)	Versandetikett als JRPrint

Example

Request

GET /api/v1/forecast/position/{positionid}/printdispatchlabel
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/v1/forecast/deliveryaddress/{deliveryaddressid}/position/list

Liefert eine Liste aller Forecastpositionen zur gegebenen Lieferadresse

Request Parameters
name	type	description	constraints
deliveryaddressid	path	Id der Forecastlieferadresse, gibt es die Forecastlieferadresse nicht, wird mit StatusCode `NOT_FOUND (404)` geantwortet	int
filter_deliverable	query	mit `true` nur lieferbare Positionen	boolean
filter_pickingtype	query	der gewünschte Kommissioniertyp	"ADDRESS" or "CALLOFF" or "ITEM" or "NOTINITIALIZED"
userid	query	ist der beim Logon ermittelte "Token"

Response Body
media type	data type	description
application/json	ForecastPositionEntryList (JSON)	eine (leere) Liste von Forecastpositionen entsprechend den Filterkriterien
application/xml;charset=UTF-8	object

Example

Request

GET /api/v1/forecast/deliveryaddress/{deliveryaddressid}/position/list
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "dateMs" : 12345,
    "ordernumber" : "...",
    "linecallEntries" : [ {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    }, {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    } ],
    "staffId" : 12345,
    "staffDescription" : "...",
    "productionCnr" : "...",
    "productType" : "STOCK",
    "id" : 12345
  }, {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "quantity" : 12345.0,
    "dateMs" : 12345,
    "ordernumber" : "...",
    "linecallEntries" : [ {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    }, {
      "quantity" : 12345.0,
      "line" : "...",
      "sector" : "...",
      "sectorDescription" : "...",
      "productionDateMs" : 12345,
      "ordernumber" : "...",
      "linecallItemEntries" : [ { }, { } ],
      "id" : 12345
    } ],
    "staffId" : 12345,
    "staffDescription" : "...",
    "productionCnr" : "...",
    "productType" : "PICKING",
    "id" : 12345
  } ]
}

ForecastApi Resource

GET /api/v1/forecast/deliveryaddress/list

Example

Request

Response

GET /api/v1/forecast/linecall/{linecallid}

Example

Request

Response

POST /api/v1/forecast/linecall/{linecallid}

Example

Request

Response

POST /api/v1/forecast/material/{positionid}

Example

Request

Response

GET /api/v1/forecast/pickingprinter/list

Example

Request

Response

GET /api/v1/forecast/position/list

Example

Request

Response

GET /api/v1/forecast/position/{positionid}

Example

Request

Response

POST /api/v1/forecast/position/{positionid}

Example

Request

Response

GET /api/v1/forecast/material/{positionid}/delivery

Example

Request

Response

POST /api/v1/forecast/material/{positionid}/delivery

Example

Request

Response

GET /api/v1/forecast/position/{positionid}/printdispatchlabel

Example

Request

Response

GET /api/v1/forecast/deliveryaddress/{deliveryaddressid}/position/list

Example

Request

Response