ForecastApi

The following resources are applicable:

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

Mount Point: /restapi/services/rest/api/v1/forecast/deliveryaddress/{deliveryaddressid}/position/list

GET

Liefert eine Liste aller Forecastpositionen zur gegebenen Lieferadresse

Parameters

name description type default
deliveryaddressid Id der Forecastlieferadresse, gibt es die Forecastlieferadresse nicht, wird mit StatusCode NOT_FOUND (404) geantwortet path
userid ist der beim Logon ermittelte "Token" query
filter_deliverable mit true nur lieferbare Positionen query
filter_pickingtype der gewünschte Kommissioniertyp query

Response Body

element: (custom)
media types: application/xml
application/json

eine (leere) Liste von Forecastpositionen entsprechend den Filterkriterien

/api/v1/forecast/deliveryaddress/list

Mount Point: /restapi/services/rest/api/v1/forecast/deliveryaddress/list

GET

Liefert eine Liste aller Forecastlieferadressen

Parameters

name description type default
userid ist der beim Logon ermittelte "Token" query
filter_deliverable mit true nur jene mit lieferbaren Positionen query

Response Body

element: forecastDeliveryAddressEntryList
media types: application/xml
application/json

eine (leere) Liste von Forecastlieferadressen entsprechend den Filterkriterien

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

Mount Point: /restapi/services/rest/api/v1/forecast/linecall/{linecallid}

GET

Einen Linenabruf anhand seiner Id ermitteln

Parameters

name description type default
linecallid Id des gesuchten Linienabrufs path
userid ist der beim Logon ermittelte "Token" query

Response Body

element: linecallEntry
media types: application/xml
application/json

den Linienabruf sofern vorhanden, gibt es den Linienabruf nicht, wird mit StatusCode NOT_FOUND (404) geantwortet

POST

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

Parameters

name description type default
linecallid Id des Linienabrufs, gibt es den Linienabruf nicht, wird mit StatusCode NOT_FOUND (404) geantwortet path

Request Body

element: linecallDeliveryPostEntry
media types: application/xml
application/json

(no documentation provided)

Response Body

element: linecallDeliveryResultEntry
media types: application/xml
application/json

ein ResultEntry mit der noch offenen Menge

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

Mount Point: /restapi/services/rest/api/v1/forecast/material/{positionid}

POST

Parameters

name description type default
positionid (no documentation provided) path
userid (no documentation provided) query
filter_pickingtype (no documentation provided) query

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

Mount Point: /restapi/services/rest/api/v1/forecast/material/{positionid}/delivery

POST

Startet die Produktion eines Positionsartikels

Parameters

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

Response Body

element: forecastPositionEntry
media types: application/xml
application/json

Forecastposition mit den zu liefernden Materialien

GET

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

Parameters

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

Response Body

element: (custom)
media types: application/xml
application/json

Liste der Linienabrufe

/api/v1/forecast/pickingprinter/list

Mount Point: /restapi/services/rest/api/v1/forecast/pickingprinter/list

GET

Liefert eine Liste aller definierten Drucker der Kommissionierung

Parameters

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

Response Body

element: pickingPrinterEntryList
media types: application/xml
application/json

eine (leere) Liste aller Kommissionierdrucker

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

Mount Point: /restapi/services/rest/api/v1/forecast/position/{positionid}

GET

Eine Forecastposition anhand seiner Id ermitteln

Parameters

name description type default
positionid Id der gesuchten Forecastposition path
userid ist der beim Logon ermittelte "Token" query
filter_deliverable (no documentation provided) query

Response Body

element: forecastPositionEntry
media types: application/xml
application/json

die Forecastposition sofern vorhanden, gibt es die Forecastposition nicht, wird mit StatusCode NOT_FOUND (404) geantwortet

POST

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

Parameters

name description type default
positionid Id der Forecastposition, gibt es die Forecastposition nicht, wird mit StatusCode NOT_FOUND (404) geantwortet path

Request Body

element: linecallDeliveryPostEntry
media types: application/xml
application/json

(no documentation provided)

Response Body

element: forecastPositionEntry
media types: application/xml
application/json

die Forecastposition mit den veränderten Mengen

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

Mount Point: /restapi/services/rest/api/v1/forecast/position/{positionid}/printdispatchlabel

GET

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

Parameters

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

Response Body

element: (custom)
media types: */*
application/xml
application/json

Versandetikett als JRPrint

/api/v1/forecast/position/list

Mount Point: /restapi/services/rest/api/v1/forecast/position/list

GET

Liefert eine Liste aller Forecastpositionen

Parameters

name description type default
userid ist der beim Logon ermittelte "Token" query
filter_deliverable mit true nur lieferbare Positionen query

Response Body

element: (custom)
media types: application/xml
application/json

eine (leere) Liste von Forecastpositionen entsprechend den Filterkriterien