Verwaltung

Stand Dezember 2020

Betriebe

Folgende Endpunkte sind verfügbar:

GET /api/v1/location GET /api/v1/location_list_complete GET /api/v1/location/{id} POST /api/v1/location PUT /api/v1/location/{id} DELETE /api/v1/location/{id}
Endpunkt
/api/v1/location
Variable
-
Aufgabe
Abrufen aller Betriebe in der testWare
Methode
GET
Felder
-
JSON
- 

[
    {
        "id": 1,
        "created": "2020-12-29 11:30:16",
        "updated": "2021-01-03 19:10:04",
        "uid": "784f64bc-735a-3d2f-8a06-fcf3d47621f3",
        "name": "HQbln153",
        "label": "bln153",
        "description": "Hauptsitz der Firma Testfirma GmbH",
        "address_id": 2,
        "employee_id": 4
    },
    {...}
]
Endpunkt
/api/v1/location_list_complete
Variable
-
Aufgabe
Abrufen aller Betriebe in der testWare inklusive:
  • der kompletten Adresse
  • leitenden Person
  • Objekte in dem Betrieb
Methode
GET
Felder
-
JSON
- 

[
    {
        "id": 1,
        "created": "2020-12-29 11:30:16",
        "updated": "2021-01-03 19:10:04",
        "uid": "784f64bc-735a-3d2f-8a06-fcf3d47621f3",
        "name": "HQbln153",
        "label": "bln153",
        "description": "Hauptsitz der Firma Testfirma GmbH",
        "address": {
            "type": {
                "name": "Heimadress",
                "description": "Standard Adresse"
            },
            "label": "Gmb5423212",
            "name": "Deckerweg 5/8 15868 Neukirchen-Vluyn",
            "company": "Testfirma GmbH",
            "company_2": null,
            "company_co": null,
            "company_unloading_point": null,
            "company_goods_income": null,
            "company_division": "UWTZIZ79",
            "street": "Christiane-Brandt-Platz",
            "no": "67",
            "zip": "63550",
            "city": "Bruchsal",
            "floor": null,
            "enterance": null
        },
        "manager": {
            "first_name": "Lenard",
            "name": "Hammer",
            "name_2": "Herr Lenard H",
            "employee_number": "1187",
            "date_birth": "1972-09-03",
            "date_entry": "2007-10-12",
            "date_leave": null,
            "phone": "0808862546",
            "mobile": "+5211706111601",
            "fax": null,
            "com_1": null,
            "com_2": null
        },
        "location_objects": {
            "buildings": 2,
            "rooms": 5,
            "compartments": 18,
            "equipment": 738
        }
    },
    {...}
]
Endpunkt
/api/v1/location/{id}
Variable
id INTEGER
Aufgabe
Ruft die Daten zum einem Betrieb mit der id
Methode
GET
Felder
-
JSON
- 

{
    "created": "2020-12-29 11:30:16",
    "updated": "2021-01-03 19:10:04",
    "uid": "784f64bc-735a-3d2f-8a06-fcf3d47621f3",
    "name": "HQbln153",
    "label": "bln153",
    "description": "Hauptsitz der Firma Testfirma GmbH",
    "address_id": 2,
    "employee_id": 4
}
Endpunkt
/api/v1/location
Variable
-
Aufgabe
Erstellt einen Betrieb. Optional mit dazugehöriger Adresse und Leitung.
Methode
POST
Felder

Erforderliche Felder

  • label STRING
  • name STRING
  • description STRING
  • uid STRING
  • address OBJECT
  • employee OBJECT

Wird das Objekt address verwendet, sind folgende Felder erforderlich

  • address.label STRING
  • address.street STRING
  • address.no STRING
  • address.zip STRING
  • address.city STRING
  • address.address_type OBJECT
  • address.name STRING
  • address.company STRING
  • address.company_2 STRING
  • address.company_co STRING
  • address.company_unloading_point STRING
  • address.company_goods_income STRING
  • address.company_division STRING

Wird das Objekt employee verwendet, sind folgende Felder erforderlich

  • employee.name STRING
  • employee.first_name STRING
  • employee.name_2 STRING
  • employee.date_birth Datum 2024-04-28 STRING
  • employee.employee_number STRING
  • employee.date_entry Datum 2024-04-28 STRING
  • employee.date_leave Datum 2024-04-28 STRING
  • employee.phone STRING
  • employee.mobile STRING
  • employee.fax STRING
  • employee.com_1 STRING
  • employee.com_2 STRING
JSON

{
    "name": "Loc-bln153",
    "label": "bln153",
    "description": "Nihil aut qui nostrum ...",
    "address": {
        "street": "Christiane-Brandt-Platz",
        "no": "67",
        "zip": "63550",
        "city": "Bruchsal",
        "address_type": {
            "name" : "Hausadresse"
        },
        "label": "Gmb5423212",
        "name": "Hausadresse Barth GmbH",
        "company": "Barth GmbH",
        "company_2": null,
        "company_co": null,
        "company_unloading_point": null,
        "company_goods_income": null,
        "company_division": "UWTZIZ79",
        "floor": null,
        "enterance": null
    },
    "employee": {
        "first_name": "Anja",
        "name": "Janssen",
        "name_2": "Fleischer",
        "date_birth": "2001-10-04",
        "employee_number": "1526",
        "date_entry": "2013-06-05",
        "date_leave": null,
        "phone": "+496180690281",
        "mobile": "+496180690281",
        "fax": "+496180690281",
        "com_1": null,
        "com_2": null
    }
}
                                

{
    "status": true,
    "id": 3,
    "uid": "74fc7d7c-04ad-4f12-a5be-07111cd73679",
    "address": 34,
    "employee": 6
}
Endpunkt
/api/v1/location/{id}
Variable
id INTEGER
Aufgabe
Aktualisiert die Daten eines Betriebes.
Methode
PUT
Felder

Erforderliche Felder

  • label STRING
  • name STRING
  • description STRING
  • uid STRING
  • address_id INTEGER
  • employee_id INTEGER
JSON

{
    "label": "bln251",
    "uid": "9f1cf9d5-370b-3413-a51c-c97c2308fe2b",
    "name": "quam-officiis-eligendi-veritatis",
    "description": "Minima maxime omnis cupiditate quas...",
    "address_id": 2,
    "employee_id": 4
}
                                

{
    "id": 1,
    "created": "2021-01-06 12:26:19",
    "updated": "2021-01-06 18:41:57",
    "label": "bln251",
    "uid": "9f1cf9d5-370b-3413-a51c-c97c2308fe2b",
    "name": "quam-officiis-eligendi-veritatis",
    "description": "Minima maxime omnis cupiditate quas...",
    "address_id": 2,
    "employee_id": 4
}
Endpunkt
/api/v1/location/{id}
Variable
id INTEGER
Aufgabe
Löscht den Betrieb.
Methode
DELETE
Felder
-
JSON
- 
{
    "status" : "location deleted"
}

Gebäude

Folgende Endpunkte sind verfügbar:

GET /api/v1/building GET /api/v1/building_list_complete GET /api/v1/building/{id} POST /api/v1/building PUT /api/v1/building/{id} DELETE /api/v1/building/{id}
Endpunkt
/api/v1/building
Variable
-
Aufgabe
Abrufen aller Gebäude der testWare
Methode
GET
Felder
-
JSON
- 
[
    {
        "id": 1,
        "created": "2021-01-05 10:44:20",
        "updated": "2021-01-05 10:44:20",
        "label": "geb-8200",
        "uid": "2a54b8f9-6ec3-3add-8e96-54f1868e1331",
        "name": "Halle T61",
        "place": "Tor Süd T61",
        "description": "Molestias cupiditate et architecto provident ut libero laborum.....",
        "goods_income_has": true,
        "goods_income_name": "WE-GT61",
        "building_type_id": 1,
        "location_id": 1
    },
    {...}
]
Endpunkt
/api/v1/building_list_complete
Variable
-
Aufgabe
Abrufen aller Gebäude der testWare inklusive Gebäudetyp und Betrieb
Methode
GET
Felder
-
JSON
- 

[
    {
        "id": 1,
        "created": "2021-01-05 10:44:20",
        "updated": "2021-01-05 10:44:20",
        "label": "geb-8200",
        "uid": "2a54b8f9-6ec3-3add-8e96-54f1868e1331",
        "name": "Halle T61",
        "place": "Tor Süd T61",
        "description": "Molestias cupiditate et architecto provident ut libero laborum.....",
        "goods_income_has": true,
        "goods_income_name": "WE-GT61",
        "type": {
            "name": "Lager",
            "description": "Gebäude zur Lagerung von Baugeräten"
        },
        "location": {
            "name": "Werk 12",
            "label": "bln153"
        },
        "building_objects": {
            "rooms": 2,
            "compartments": 4,
            "equipment": 226
        }
    },
    {...}
]
Endpunkt
/api/v1/building/{id}
Variable
id INTEGER
Aufgabe
Ruft die Daten zu einem Gebäude mit der id
Methode
GET
Felder
-
JSON
- 

{
    "created": "2021-01-05 10:44:20",
    "updated": "2021-01-05 10:44:20",
    "label": "geb-8200",
    "uid": "2a54b8f9-6ec3-3add-8e96-54f1868e1331",
    "name": "Halle T61",
    "place": "Tor Süd T61",
    "description": "Molestias cupiditate et architecto provident ut libero laborum.....",
    "goods_income_has": true,
    "goods_income_name": "WE-GT61",
    "type": {
        "name": "Lager",
        "description": "Gebäude zur Lagerung von Maschienen"
    },
    "location": {
        "name": "Werk 12",
        "label": "bln153"
    }
}
Endpunkt
/api/v1/building
Variable
-
Aufgabe
Erstellt ein Gebäude.
Methode
POST
Felder

Erforderliche Felder

  • label STRING
  • goods_income_has BOOLEAN
  • description STRING
  • uid STRING
  • name STRING
  • place STRING
  • type OBJECT
  • location_id INTEGER

Wird das Objekt <code>type</code> verwendet, sind folgende Felder erforderlich

  • type.name STRING
  • type.description STRING
JSON

{
    "label" : "b12345",
    "goods_income_has" : false,
    "uid" : "430eb8b6-619c-4ebf-8c54-b139b99e7a33",
    "type" : {
        "name": "Büro",
        "description": "Gebäude mit reiner Büronutzung"
    },
    "name" : "Gebäude 12345",
    "place" : "Tor Nord",
    "description" : "Bürogebäude Zentraleinkauf",
    "goods_income_name" : null,
    "location_id" : 1
}
                                

{
    "id": 7,
    "created": "2021-01-06 19:15:06",
    "updated": "2021-01-06 19:15:06",
    "label": "b123435",
    "uid": "430eb8b6-619c-4ebf-8c54-b139b99e7a32",
    "name": "Bürogebäude Zentraleinkauf",
    "place": "Tor Nord",
    "description": null,
    "goods_income_has": true,
    "goods_income_name": null,
    "building_type_id": 1,
    "location_id": 1
}
Endpunkt
/api/v1/building/{id}
Variable
id INTEGER
Aufgabe
Aktualisiert die Daten eines Betriebes.
Methode
PUT
Felder

Erforderliche Felder

  • label STRING
  • goods_income_has BOLEAN
  • uid STRING
  • description STRING
  • goods_income_name STRING
  • place STRING
  • type_id INTEGER
  • location_id INTEGER
JSON

{
    "label": "geb-1498",
    "uid": "3e982f3e-4fd2-3dae-b748-f5c19efd1cae",
    "name": "necessitatibus-ullam-eum",
    "place": "5c",
    "description": "Voluptas libero voluptatum vel maxime. Fugiat quod quis vitae saepe quis harum libero eaque. Qui quam et ab voluptatem cum. Ea commodi harum consequatur neque.",
    "goods_income_has": true,
    "goods_income_name": "3",
    "type_id" : 2,
    "location_id" : 1
}
                                

{
    "created": "2021-01-06 12:26:19",
    "updated": "2021-01-06 20:05:22",
    "label": "geb-1498",
    "uid": "3e982f3e-4fd2-3dae-b748-f5c19efd1cae",
    "name": "necessitatibus-ullam-eum",
    "place": "5c",
    "description": "Voluptas libero voluptatum vel maxime. Fugiat quod quis vitae saepe quis harum libero eaque. Qui quam et ab voluptatem cum. Ea commodi harum consequatur neque.",
    "goods_income_has": true,
    "goods_income_name": "3",
    "type": {
        "name": "Werkstatt",
        "description": "Gebäude mit reiner Werkstattnutzung"
    },
    "location": {
        "name": "quam-officiis-eligendi-veritatis",
        "label": "bln251"
    }
}
Endpunkt
/api/v1/building/{id}
Variable
id INTEGER
Aufgabe
Löscht den Betrieb.
Methode
DELETE
Felder
-
Antwort
{
        "status" : "building deleted"
    }

Räume

Folgende Endpunkte sind verfügbar:

GET /api/v1/room GET /api/v1/room_list_complete GET /api/v1/room/{id} POST /api/v1/room PUT /api/v1/room/{id} DELETE /api/v1/room/{id}
Endpunkt
/api/v1/room
Variable
-
Aufgabe
Abrufen aller Räume der testWare
Methode
GET
Felder
-
JSON
- 
[
    {
        "id": 1,
        "created": "2021-01-06 12:26:19",
        "updated": "2021-01-06 12:26:19",
        "label": "rm-142",
        "uid": "3e0b5fb1-423f-383e-b040-9f93d0c47c9d",
        "name": "ipsum",
        "description": "Optio et mollitia tempore consequatur. Magnam debitis doloremque voluptatem pariatur omnis. Alias ut beatae enim aperiam laborum pariatur. Quod voluptate et quis omnis voluptatem et dolorum. Cumque est eum ducimus nemo dolores eos. Nesciunt ut fuga quia et sed assumenda.",
        "building_id": 2,
        "room_type_id": 3
    },
    {...}
]
Endpunkt
/api/v1/room_list_complete
Variable
-
Aufgabe
Abrufen aller Räume der testWare inklusive Räumetyp, Details des Gebäude und Anzahl der Objekte des Raums im Zusatzfeld room_objects
Methode
GET
Felder
-
JSON
- 

[
    {
        "id": 1,
        "created": "2021-01-05 10:44:20",
        "updated": "2021-01-05 10:44:20",
        "label": "rm-117",
        "uid": "1e0cfa36-e485-36c7-8f22-21c83884a442",
        "name": "quis",
        "description": "Amet minus dolorum at reprehenderit velit iste...",
        "type": {
            "label": "Material"
        },
        "building": {
            "label": "geb-7715",
            "uid": "11a26323-672d-3ebf-92c0-349d1c397f6a",
            "name": "fugit-qui",
            "description": "Et magnam atque quidem ratione qui voluptates..."
        },
        "room_objects": {
            "compartments": 7,
            "equipment": 240
        }
    },
    {...}
]
Endpunkt
/api/v1/room/{id}
Variable
id INTEGER
Aufgabe
Ruft die Daten zum einem Räume mit der id
Methode
GET
Felder
-
JSON
- 

{
    "id": 1,
    "created": "2021-01-05 10:44:20",
    "updated": "2021-01-05 10:44:20",
    "label": "rm-117",
    "uid": "1e0cfa36-e485-36c7-8f22-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "building_id": 2,
    "room_type_id": 3
}
Endpunkt
/api/v1/room
Variable
-
Aufgabe
Erstellt ein Räume.
Methode
POST
Felder

Erforderliche Felder

  • label STRING
  • uid STRING
  • name STRING
  • description STRING
  • building_id INTEGER

  • room_type_id INTEGER

    oder

    type OBJECT

Wird das Objekt <code>type</code> verwendet, sind folgende Felder erforderlich

  • type.label STRING
  • type.name STRING
  • type.description STRING
JSON

{
    "label": "rm-118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "type" : {
        "label": "Büro",
        "name": "Räume mit reiner Büronutzung",
        "description": null
    },
    "building_id": 5
}
                                

{
    "id": 15,
    "created": "2021-01-06 20:42:10",
    "updated": "2021-01-06 20:42:10",
    "label": "rm-118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "building_id": 5,
    "room_type_id": 1
}
Endpunkt
/api/v1/room/{id}
Variable
id INTEGER
Aufgabe
Aktualisiert die Daten eines Raums mit der Referenz {id}.
Methode
PUT
Felder

Erforderliche Felder

  • label STRING
  • uid STRING
  • name STRING
  • description STRING
  • building_id INTEGER

  • room_type_id INTEGER

    oder

    type OBJECT

Wird das Objekt <code>type</code> verwendet, sind folgende Felder erforderlich

  • type.label STRING
  • type.name STRING
  • type.description STRING
JSON

{
    "label": "rm-118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "room_type_id" : 2,
    "building_id": 5
}
                                

{
    "id": 1,
    "created": "2021-01-06 22:23:44",
    "updated": "2021-01-06 23:07:33",
    "label": "rm-118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "room_type_id" : 2,
    "building_id": 5
}
Endpunkt
/api/v1/room/{id}
Variable
id INTEGER
Aufgabe
Löscht den Raum mit der Referenz {id}.
Methode
DELETE
Felder
-
Antwort

    {
        "status" : "room deleted"
    }

Stellplätze

Folgende Endpunkte sind verfügbar:

GET /api/v1/compartment GET /api/v1/compartment_list_complete GET /api/v1/compartment/{id} POST /api/v1/compartment PUT /api/v1/compartment/{id} DELETE /api/v1/compartment/{id}
Endpunkt
/api/v1/compartment
Variable
-
Aufgabe
Abrufen aller Stellplätze der testWare
Methode
GET
Felder
-
JSON
- 
[
    {
        "id": 1,
        "created": "2021-01-06 12:26:19",
        "updated": "2021-01-06 12:26:19",
        "label": "rm-142",
        "uid": "3e0b5fb1-423f-383e-b040-9f93d0c47c9d",
        "name": "ipsum",
        "description": "Optio et mollitia tempore consequatur. Magnam debitis doloremque voluptatem pariatur omnis. Alias ut beatae enim aperiam laborum pariatur. Quod voluptate et quis omnis voluptatem et dolorum. Cumque est eum ducimus nemo dolores eos. Nesciunt ut fuga quia et sed assumenda.",
        "building_id": 2,
        "compartment_type_id": 3
    },
    {...}
]
Endpunkt
/api/v1/compartment_list_complete
Variable
-
Aufgabe
Abrufen aller Stellplätze der testWare inklusive Stellplatztyp, Details des Raums und Anzahl der Objekte des Stellplatz im Zusatzfeld objects
Methode
GET
Felder
-
JSON
- 
[
    {
        "id": 1,
        "created": "2021-01-06 22:23:44",
        "updated": "2021-01-06 22:23:44",
        "label": "SP.7-ru0rxn",
        "type": {
            "label": "Schubfach",
            "id": 2
        },
        "name": "quos-repudiandae-et-quia-quas-ad-voluptatem-ratione",
        "description": null,
        "room": {
            "label": "rm-114",
            "uid": "e205dab4-5472-30ba-a774-8b032482d2df"
        },
        "objects": {
            "equipment": 23
        }
    },
    {...}
]
Endpunkt
/api/v1/compartment/{id}
Variable
id INTEGER
Aufgabe
Ruft die Daten zum einem Stellplatz mit der id
Methode
GET
Felder
-
JSON
- 
{
    "id": 1,
    "created": "2021-01-06 22:23:44",
    "updated": "2021-01-06 22:23:44",
    "label": "SP.7-ru0rxn",
    "uid": "c9903a08-728a-3067-bf79-ec24ab757713",
    "name": "quos-repudiandae-et-quia-quas-ad-voluptatem-ratione",
    "description": null,
    "compartment_type_id": 2,
    "room_id": 9
}
Endpunkt
/api/v1/compartment
Variable
-
Aufgabe
Erstellt einen Stellplatz.
Methode
POST
Felder

Erforderliche Felder

  • label STRING
  • uid STRING
  • name STRING
  • description STRING
  • room_id INTEGER

  • compartment_type_id INTEGER

    oder

    type OBJECT

Wird das Objekt <code>type</code> verwendet, sind folgende Felder erforderlich

  • type.label STRING
  • type.name STRING
  • type.description STRING
JSON
{
    "label": "sp.2118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "W.1.2.3.a.12",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "type" : {
        "label": "Fach-DIN-3",
        "name": "Lagerfach für Kästen DIN-3",
        "description": null
    },
    "room_id": 5
}
{
    "id": 49,
    "created": "2021-01-07 18:09:37",
    "updated": "2021-01-07 18:09:37",
    "label": "sp.2118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "W.1.2.3.a.12",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "compartment_type_id": 4,
    "room_id": 5
}
Endpunkt
/api/v1/compartment/{id}
Variable
id INTEGER
Aufgabe
Aktualisiert die Daten eines Stellplatzes mit der Referenz {id}.
Methode
PUT
Felder

Erforderliche Felder

  • label STRING
  • uid STRING
  • name STRING
  • description STRING
  • room_id INTEGER

  • compartment_type_id INTEGER

    oder

    type OBJECT

Wird das Objekt <code>type</code> verwendet, sind folgende Felder erforderlich

  • type.label STRING
  • type.name STRING
  • type.description STRING
JSON
{
    "label": "rm-118",
    "uid": "1e0cfa36-e485-36c7-8f26-21c83884a442",
    "name": "quis",
    "description": "Amet minus dolorum at reprehenderit velit iste laudantium...",
    "compartment_type_id" : 1,
    "building_id": 5
}
{
    "id": 50,
    "created": "2021-01-07 21:33:02",
    "updated": "2021-01-07 22:18:11",
    "label": "sp.2112",
    "uid": "1e0cfa36-e485-36c7-8f26-21c838842442",
    "name": "W.1.2.3.a.12",
    "description": "Amet minuszf dolorum at reprehenderit velit iste laudantium...",
    "compartment_type_id": 1,
    "room_id": 5
}
Endpunkt
/api/v1/compartment/{id}
Variable
id INTEGER
Aufgabe
Löscht den Stellplatz mit der Referenz {id}.
Methode
DELETE
Felder
-
Antwort
{
    "status" : "compartment deleted"
}