ZeroWaste Siirtoasiakirja -rajapinta

Yleistä

Rajapintatunnukset

Rajapintatunnukset myöntää Enpros Oy. Tunnukset saa sähköpostitse osoitteesta asiakaspalvelu@enpros.fi. Liitä viestiin lyhyt selvitys mihin tarkoitukseen tarvitsette rajapintaa.

Testiympäristö

Rajapintatestaus tehdään ympäristössä demo8.zerowaste.fi

Siirtoasiakirjat

Siirtoasiakirjan lisääminen

Kuljetusyritysten rajapintakäyttäjät
Huom! Tuotavan siirtoasiakirjan id:n määrittää ZeroWaste, joten kenttä jätetään pois aineistosta.
Asiakkaiden, kohteiden ja laitosten tiedot tuodaan tarvittaessa rajapinnan kautta ennen siirtoasiakirjan lisäämistä. Siirtoasiakirjaa lisättäessä näiden tietoja ei myöskään päivitetä.
Ja kuljetusyritys on toiminut alihankkijana, niin pääurakoitsija tuodaan master_transporter -elementissä. Normaalisti master_transporter -elementtiä ei käytetä.
[POST] /api2/v1/document/save
Esimerkki 1:

        {
            "date": "2022-05-04T10:35:00",
            "unit": {
                "id": "26694"
            },
            "vehicle_licenceplate": "JTK-666",
            "driver": {
                "username": "Esi Merkkinen",
                "phone": "04002222222"
            },
            "plant": {
                "id": "1087"
            },
            "wastes": [
                {
                    "row_id": null,
                    "material": {
                        "id": "422"
                    },
                    "weight": 12.800,
                    "description": "Siirtoasiakirjarivin selite"
                }
            ]
        }

Esimerkki 2, alihankkijana tehty siirtoasiakirja:

        {
            "date": "2022-05-04T10:35:00",
            "unit": {
                "id": "26694"
            },
            "master_transporter": {
                "id": 132,
                "name": "Isompi Firma Oy"
            },
            "vehicle_licenceplate": "JTK-666",
            "driver": {
                "username": "Esi Merkkinen",
                "phone": "04002222222"
            },
            "plant": {
                "id": "1087"
            },
            "wastes": [
                {
                    "row_id": null,
                    "material": {
                        "id": "422"
                    },
                    "weight": 12.800,
                    "description": "Siirtoasiakirjarivin selite"
                }
            ]
        }

Siirtoasiakirjarivin lisääminen olemassa olevalle siirtoasiakirjalle

Kuljetusyritysten rajapintakäyttäjät
Huom! Tuotavan siirtoasiakirjarivin id:n määrittää ZeroWaste, joten kenttä jätetään pois aineistosta. Juuri-siirtoasiakirjan root_id tuodaan aineistossa.
[POST] /api2/v1/document/save
Esimerkki:

        {
            "root_id": "1234",
            "wastes": [
                {
                    "row_id": null,
                    "material": {
                        "id": "429"
                    },
                    "weight": 38.123,
                    "volume": 3.123,
                    "amount": 3.63,
                    "description": "juhuu"
                }
            ]
        }

Painon päivittäminen ja punnitustositten lisäämien siirtoasiakirjariville

Laitosten rajapintakäyttäjät
[POST] /api2/v1/document/addreceipt
Esimerkki:

        {
            "row_id": "263028",
            "date_1": "2018-09-04T18:50:00",
            - kesken -
            "weight": 5.18
        }

Asiakkaat ja kohteet

Asiakkaan lisääminen

Kuljetusyritysten rajapintakäyttäjät
Huom! Tuotavan asiakkaan id:n määrittää ZeroWaste, joten kenttä jätetään pois aineistosta.
[POST] /api2/v1/customer/save
Esimerkki:

        {
            "name": "Iso Asiakas Oy",
            "companycode": "123456-7",
            "customernumber": "10040401",
            "email": "iso.asiakas@isoasiakas.com",
            "phone": "Nokia 3100",
            "address": {
                "streetaddress": "PL 401",
                "postalcode": "33101",
                "city": "TAMPERE",
                "country": ""
            },
            "description": "Pieni asiakas"
        }

Kohteen / työmaan lisääminen asiakkaalle

Kuljetusyritysten rajapintakäyttäjät
Huom! Tuotavan kohteen id:n määrittää ZeroWaste, joten kenttä jätetään pois aineistosta. ZeroWastesta löytyvän asiakkaan tunniste customer_id tuodaan aineistossa.
[POST] /api2/v1/unit/save
Esimerkki:

        {
            "customer_id": "44577",
            "name": "Varasto 2",
            "companycode": "123456-7",
            "customernumber": "2468",
            "email": "email@asiakas.fix",
            "phone": "04009988776",
            "address": {
              "streetaddress": "Tikkatie 16",
              "postalcode": "80200",
              "city": "Joensuu",
              "country": "Suomi"
            },
            "contact": "2",
            "description": "Kohteen lisätieto",
            "description2": "Kohteen sisäinen lisätieto, ei näy kuljettajalle",
            "coordinates": {
              "lat": 62.602079,
              "lng": 29.75967
            }
        }

Kohteen tietojen päivittäminen

Kuljetusyritysten rajapintakäyttäjät
[POST] /api2/v1/unit/save
Esimerkki:

        {
            "id": "96545",
            "name": "Varasto 6",
            "companycode": "123456-7",
            "customernumber": "12345678",
            "email": "email@asiakas.fix",
            "phone": "04009988776",
            "address": {
                "streetaddress": "Tikkatie 16 B 44",
                "postalcode": "80200",
                "city": "Joensuu",
                "country": "Suomi"
            },
            "contact": "2",
            "description": "Kohteen lisätieto",
            "description2": "Kohteen sisäinen lisätieto, ei näy kuljettajalle",
            "coordinates": {
                "lat": 62.602079,
                "lng": 29.75967
            }
        }