StockApi Resource

GET /api/v1/stock

Eine Liste aller Lager

Request Parameters
name type description
userid query des bei HELIUM V angemeldeten API Benutzer
Response Body
media type data type description
application/json StockEntryList (JSON) eine (leere) Liste aller Lager die dem angemeldeten Benutzer zugänglich sind
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/stock
Content-Type: */*
Accept: application/json

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

                
{
  "entries" : [ {
    "name" : "...",
    "typeCnr" : "...",
    "id" : 12345
  }, {
    "name" : "...",
    "typeCnr" : "...",
    "id" : 12345
  } ]
}

GET /api/v1/stock/{stockid}/place

Lagerplatz optional über seine Id oder seinen Namen finden.
Der Lagerplatz enthält auch eine Liste aller Artikel, die diesem zugeordnet sind.

Request Parameters
name type description constraints
stockid path ist die Id des Lagers in dem sich der Lagerplatz befindet int
addStockAmountInfos query (optional) fügt Lagerinformation hinzu, der Lagerstand darin ist jener des Lagers der Ressource (stockid) boolean
stockplaceid query (optional) ist die Id des Lagerplatzes int
stockplacename query (optional) ist der Name des Lagerplatzes  
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  
Response Body
media type data type description
application/json StockPlaceEntry (JSON) Lagerplatz
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/stock/{stockid}/place
Content-Type: */*
Accept: application/json

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

                
{
  "name" : "...",
  "items" : {
    "entries" : [ {
      "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
    }, {
      "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
    } ]
  },
  "id" : 12345
}

POST /api/v1/stock/{stockid}/place

Ordnet einen Artikel zu einem existierenden Lagerplatz zu.

Request Parameters
name type description constraints
stockid path ist die Id des Lagers in dem sich der Lagerplatz befindet int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  
Request Body
media type data type description
application/json StockPlacePostEntry (JSON) sind die Daten des Lagerplatzes
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json number (JSON) die Id des Lagerplatzes
application/xml int (XML)

Example

Request
POST /api/v1/stock/{stockid}/place
Content-Type: application/json
Accept: application/json

                
{
  "stockplaceId" : 12345,
  "stockplaceName" : "...",
  "itemId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /api/v1/stock/{stockid}/movement/{itemid}

Einen Lagerabgang durchführen

Der Anwender (userId) muss das Recht haben, Handlagerbewegungen durchzuführen. Ebenso muss dieser das Recht haben, auf das abzubuchende Lager zuzugreifen.

Request Parameters
name type description constraints
itemid path ist die Id des zuzubuchenden Artikels. Es muss sich um einen lagerbewirtschafteten Identartikel handeln int
stockid path ist die Id des Lagers von dem abgebucht wird. Der Anwender muss das Recht haben auf dieses Lager zuzugreifen int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde. Dieser Anwender benötigt das Recht Handlagerbewegungen durchführen zu dürfen  
Request Body
media type data type description
application/json StockMovementEntry (JSON) die Datenstruktur die den Lagerabgang definiert
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json number (JSON) die Id der neu erzeugten Handlagerbewegung
application/xml int (XML)

Example

Request
DELETE /api/v1/stock/{stockid}/movement/{itemid}
Content-Type: application/json
Accept: application/json

                
{
  "price" : 12345.0,
  "amount" : 12345.0,
  "comment" : "...",
  "identities" : {
    "entries" : [ {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    }, {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    } ]
  },
  "id" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /api/v1/stock/{stockid}/movement/{itemid}

Eine Liste aller Handlagerbewegungen des Artikels auf diesem Lager

Request Parameters
name type description constraints
itemid path ist die Id des Artikels. Es muss sich um einen lagerbewirtschafteten Identartikel handeln int
stockid path ist die Id des Lagers vom dem die Handlagerbewegungen ermittelt werden sollen int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde. Dieser Anwender benötigt das Recht Handlagerbewegungen durchführen zu dürfen  
Response Body
media type data type description
application/json StockMovementEntryList (JSON) eine (leere) Liste aller Handlagerbewegungen des Artikels auf diesem Lager
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/stock/{stockid}/movement/{itemid}
Content-Type: */*
Accept: application/json

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

                
{
  "entries" : [ {
    "price" : 12345.0,
    "amount" : 12345.0,
    "comment" : "...",
    "identities" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  }, {
    "price" : 12345.0,
    "amount" : 12345.0,
    "comment" : "...",
    "identities" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  } ],
  "rowCount" : 12345
}

POST /api/v1/stock/{stockid}/movement/{itemid}

Einen Lagerzugang durchführen

Der Anwender (userId) muss das Recht haben, Handlagerbewegungen durchzuführen. Ebenso muss dieser das Recht haben, auf das zuzubuchende Lager zuzugreifen.

Request Parameters
name type description constraints
itemid path ist die Id des zuzubuchenden Artikels. Es muss sich um einen lagerbewirtschafteten Identartikel handeln int
stockid path ist die Id des Lagers auf das zugebucht wird. Der Anwender muss das Recht haben auf dieses Lager zugreifen zu dürfen int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde. Dieser Anwender benötigt das Recht Handlagerbewegungen durchführen zu dürfen  
Request Body
media type data type description
application/json StockMovementEntry (JSON) die Datenstruktur, die die Zubuchung definiert
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json number (JSON) die Id der neu erzeugten Handlagerbewegung
application/xml int (XML)

Example

Request
POST /api/v1/stock/{stockid}/movement/{itemid}
Content-Type: application/json
Accept: application/json

                
{
  "price" : 12345.0,
  "amount" : 12345.0,
  "comment" : "...",
  "identities" : {
    "entries" : [ {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    }, {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    } ]
  },
  "id" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /api/v1/stock/{stockid}/movement/{itemid}

Eine Lagerumbuchung durchführen

Es wird eine Abbuchung und eine Zubuchung durchgef&auuml;hrt

Request Parameters
name type description constraints
itemid path ist die Id des umzubuchenden Artikels. Es muss sich um einen lagerbewirtschafteten Identartikel handeln int
stockid path ist die Id des Lagers vom dem abgebucht wird. Der Anwender muss das Recht haben auf dieses Lager zuzugreifen int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde. Dieser Anwender benötigt das Recht Handlagerbewegungen durchführen zu dürfen  
Request Body
media type data type description
application/json StockMovementChangeEntry (JSON) die Datenstruktur, die die Identitäten und das Ziellager definiert
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json number (JSON) die Id der neu erzeugten Handlagerbewegung
application/xml int (XML)

Example

Request
PUT /api/v1/stock/{stockid}/movement/{itemid}
Content-Type: application/json
Accept: application/json

                
{
  "targetStockId" : 12345,
  "price" : 12345.0,
  "amount" : 12345.0,
  "comment" : "...",
  "identities" : {
    "entries" : [ {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    }, {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    } ]
  },
  "id" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

DELETE /api/v1/stock/{stockid}/place/{stockplaceid}

Löscht die Zuordnung eines Artikel zu einem Lagerplatz

Request Parameters
name type description constraints
stockid path ist die Id des Lagers in dem sich der Lagerplatz befindet int
stockplaceid path ist die Id des Lagerplatzes int
itemid query ist die Id des Artikels int
userid query ist der Token der durch die Anmeldung (login) erhalten wurde  

Example

Request
DELETE /api/v1/stock/{stockid}/place/{stockplaceid}
Content-Type: application/json;charset=UTF-8

                
...
Response
HTTP/1.1 204 No Content