GET/production-api/polygonpackage/getbyid

Retrieve a ProductionPolygonPackage by its ID

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

id*integer

The ID of the desired ProductionPolygonPackage

Response Body

application/json

curl -X GET "https://example.com/production-api/polygonpackage/getbyid?id=0"
{  "id": 0,  "productionPolygonId": 0,  "productionPackageId": 0,  "barcode": "string",  "packedAt": "2019-08-24T14:15:22Z",  "amount": 1,  "parentPolygonPackageId": 0,  "childPolygonPackageIds": [    0  ]}
Empty
Empty
GET/production-api/polygonpackage/getbybarcode

Retrieves all ProductionPolygonPackages that match the barcode

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

barcode*string

The barcode that should be used to find the ProductionPolygonPackages

Response Body

application/json

curl -X GET "https://example.com/production-api/polygonpackage/getbybarcode?barcode=string"
[  {    "id": 0,    "productionPolygonId": 0,    "productionPackageId": 0,    "barcode": "string",    "packedAt": "2019-08-24T14:15:22Z",    "amount": 1,    "parentPolygonPackageId": 0,    "childPolygonPackageIds": [      0    ]  }]
Empty
GET/production-api/polygonpackage/getbypolygon

Retrieves all ProductionPolygonPackages belonging to a specific ProductionPolygon

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

productionPolygonId*integer

The ID of the ProductionPolygon

Response Body

application/json

curl -X GET "https://example.com/production-api/polygonpackage/getbypolygon?productionPolygonId=0"
[  {    "id": 0,    "productionPolygonId": 0,    "productionPackageId": 0,    "barcode": "string",    "packedAt": "2019-08-24T14:15:22Z",    "amount": 1,    "parentPolygonPackageId": 0,    "childPolygonPackageIds": [      0    ]  }]
Empty
PUT/production-api/polygonpackage/create

Creates a new ProductionPolygonPackage

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Request Body

The desired ProductionPolygonPackage

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/production-api/polygonpackage/create" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": 0,  "productionPolygonId": 0,  "productionPackageId": 0,  "barcode": "string",  "packedAt": "2019-08-24T14:15:22Z",  "amount": 1,  "parentPolygonPackageId": 0,  "childPolygonPackageIds": [    0  ]}
Empty
Empty
PATCH/production-api/polygonpackage/update

Updates an existing ProductionPolygonPackage

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Request Body

The updated ProductionPolygonPackage model

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/production-api/polygonpackage/update" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": 0,  "productionPolygonId": 0,  "productionPackageId": 0,  "barcode": "string",  "packedAt": "2019-08-24T14:15:22Z",  "amount": 1,  "parentPolygonPackageId": 0,  "childPolygonPackageIds": [    0  ]}
Empty
Empty
DELETE/production-api/polygonpackage/delete

Deletes an existing ProductionPolygonPackage

AuthorizationBearer <token>

Access Token used to access this API (JWT bearer token).

In: header

Query Parameters

id*integer

The ProductionPolygonPackage ID

Response Body

curl -X DELETE "https://example.com/production-api/polygonpackage/delete?id=0"
Empty
Empty
Empty

On this page