Verordnungen

Stand 2020.Dezember

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"
}