General Description

HTTP method	API version
POST	v1

Don’t forget to put the Authorization field in the header

API Path: /Devices
or

Fields

The following fields are available:

Field Name	Type
id	Number
maintenancesheet_id	Number
group	String
nr	String
description	String
product_id	Number
machine_id	Number
unit	String
quantity	Number
serialnr	String
typenr	String
brand	String
constructionyear	Number
active	Boolean
installationdate	String
lastmaintenance	String
nextmaintenance	String
maintenancecycle	String
ef_Brander.1traps.Bool	Boolean
ef_Brander.Aantalbrandgangen.Text	String
ef_Brander.Bouwjaar.Int	Number
ef_Brander.Debiet.Text	String
ef_Brander.Fabricatienr.Text	String
ef_Brander.Merk.Text	String
ef_Brander.Modulerend.Bool	Boolean
ef_Brander.ntraps.Bool	Boolean
ef_Brander.ntrapsAantal.Int	Number
ef_Brander.Type.Text	String
ef_Installatie.Warmteoverdrachtsvloeistof.StoomOnderLageDruk.Bool	Boolean
ef_Installatie.Warmteoverdrachtsvloeistof.ThermischeOlie.Bool	Boolean
ef_Installatie.Warmteoverdrachtsvloeistof.Water.Bool	Boolean
ef_Installatie.Warmteproductie.ECS.Bool	Boolean
ef_Installatie.Warmteproductie.Verwarming.Bool	Boolean
ef_Installatie.Warmteproductie.VerwarmingEnECS.Bool	Boolean
ef_Kenmerken.Aansluittype.Text	String
ef_Kenmerken.AansluittypeB.Text	String
ef_Kenmerken.AansluittypeC.Text	String
ef_Kenmerken.AantalVerwarmingstoestellen.Text	String
ef_Kenmerken.Centraal.Bool	Boolean
ef_Kenmerken.IdentificatieVerwarmingstoestel.Text	String
ef_Kenmerken.TypeB.Open.Bool	Boolean
ef_Kenmerken.TypeC.Gesloten.Bool	Boolean
ef_KenmerkenGas.Aardgas.Bool	Boolean
ef_KenmerkenGas.AardgasG20.Bool	Boolean
ef_KenmerkenGas.AardgasG25.Bool	Boolean
ef_KenmerkenGas.Andere.Bool	Boolean
ef_KenmerkenGas.Andere.Text	String
ef_KenmerkenGas.Biogas.Bool	Boolean
ef_KenmerkenGas.Butaan.Bool	Boolean
ef_KenmerkenGas.Gasketel.Unit.Bool	Boolean
ef_KenmerkenGas.Gasketel.VentilatorBrander.GII.Bool	Boolean
ef_KenmerkenGas.Gasvormige.Brandstof.Bool	Boolean
ef_KenmerkenGas.Label.Energielabel.Bool	Boolean
ef_KenmerkenGas.Label.Energielabel.Text	String
ef_KenmerkenGas.Label.Geen.Bool	Boolean
ef_KenmerkenGas.Label.HR.Bool	Boolean
ef_KenmerkenGas.Label.HRPlus.Bool	Boolean
ef_KenmerkenGas.Label.HRTop.Bool	Boolean
ef_KenmerkenGas.Label.Wit.Bool	Boolean
ef_KenmerkenGas.LPG.Bool	Boolean
ef_KenmerkenGas.NietPremix.GI.Bool	Boolean
ef_KenmerkenGas.Premix.GI.Bool	Boolean
ef_KenmerkenGas.Propaan.Bool	Boolean
ef_KenmerkenVast.Andere.Bool	Boolean
ef_KenmerkenVast.Andere.Text	String
ef_KenmerkenVast.Granen.Bool	Boolean
ef_KenmerkenVast.Houtblokken.Bool	Boolean
ef_KenmerkenVast.Houtpellets.Bool	Boolean
ef_KenmerkenVast.Label.Energielabel.Bool	Boolean
ef_KenmerkenVast.Label.Energielabel.Text	String
ef_KenmerkenVast.Label.Geen.Bool	Boolean
ef_KenmerkenVast.Spaanders.Bool	Boolean
ef_KenmerkenVast.Steenkool.Bool	Boolean
ef_KenmerkenVast.VasteBrandstof.Bool	Boolean
ef_KenmerkenVloeibaar.Andere.Bool	Boolean
ef_KenmerkenVloeibaar.Gasolie.Bool	Boolean
ef_KenmerkenVloeibaar.GasolieExtra.Bool	Boolean
ef_KenmerkenVloeibaar.Label.Energielabel.Bool	Boolean
ef_KenmerkenVloeibaar.Label.Energielabel.Text	String
ef_KenmerkenVloeibaar.Label.Geen.Bool	Boolean
ef_KenmerkenVloeibaar.Label.Optimaz.Bool	Boolean
ef_KenmerkenVloeibaar.Label.OptimazElite.Bool	Boolean
ef_KenmerkenVloeibaar.VloeibareBrandstof.Bool	Boolean
ef_KenmerkenVloeibaar.VloeibareBrandstof.Type.Text	String
ef_KenmerkenVloeibaar.ZwareStookolie.Bool	Boolean
ef_Toestel.AlsGasOpenKetelJa.Bool	Boolean
ef_Toestel.AlsGasOpenKetelNee.Bool	Boolean
ef_Toestel.AlsMazoutLuchtOfRookklepJa.Bool	Boolean
ef_Toestel.AlsMazoutLuchtOfRookklepNee.Bool	Boolean
ef_Toestel.Bouwjaar.Int	Number
ef_Toestel.CondensatieJa.Bool	Boolean
ef_Toestel.CondensatieNee.Bool	Boolean
ef_Toestel.Fabricatienr.Text	String
ef_Toestel.KenplaatAanwezig.Bool	Boolean
ef_Toestel.KenplaatAfwezig.Bool	Boolean
ef_Toestel.Label.Text	String
ef_Toestel.Merk.Text	String
ef_Toestel.Type.Text	String
ef_Toestel.Vermogen.Double	Number

/Devices

API Path: /Devices/

If everything succeeds the HTTP response status is 201
(201 CREATED)

If you forget to send the Authorization, the response status and code is 401
(401 Unauthorized)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/Devices

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: OrPfWxfjjtzSfOVfIfzRqbGkfIjUGfVmftAbzrUOAAOfPrUftm

Query Parameters :
ParameterName: columns, ParameterValue: maintenancesheet_id=553,product_id=2809432

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 880,
    "maintenancesheet_id": 553,
    "group": "",
    "nr": "190165",
    "description": "Accumulatoren Blue",
    "product_id": 2809432,
    "machine_id": 0,
    "unit": "st.",
    "quantity": 0,
    "serialnr": "",
    "typenr": "",
    "brand": "",
    "constructionyear": 0,
    "active": true,
    "installationdate": "",
    "lastmaintenance": "",
    "nextmaintenance": "",
    "maintenancecycle": "",
    "ef_Brander.1traps.Bool": false,
    "ef_Brander.Aantalbrandgangen.Text": "",
    "ef_Brander.Bouwjaar.Int": 0,
    "ef_Brander.Debiet.Text": "",
    "ef_Brander.Fabricatienr.Text": "",
    "ef_Brander.Merk.Text": "",
    "ef_Brander.Modulerend.Bool": false,
    "ef_Brander.ntraps.Bool": false,
    "ef_Brander.ntrapsAantal.Int": 0,
    "ef_Brander.Type.Text": "",
    "ef_Installatie.Warmteoverdrachtsvloeistof.StoomOnderLageDruk.Bool": false,
    "ef_Installatie.Warmteoverdrachtsvloeistof.ThermischeOlie.Bool": false,
    "ef_Installatie.Warmteoverdrachtsvloeistof.Water.Bool": false,
    "ef_Installatie.Warmteproductie.ECS.Bool": false,
    "ef_Installatie.Warmteproductie.Verwarming.Bool": false,
    "ef_Installatie.Warmteproductie.VerwarmingEnECS.Bool": false,
    "ef_Kenmerken.Aansluittype.Text": "",
    "ef_Kenmerken.AansluittypeB.Text": "",
    "ef_Kenmerken.AansluittypeC.Text": "",
    "ef_Kenmerken.AantalVerwarmingstoestellen.Text": "",
    "ef_Kenmerken.Centraal.Bool": false,
    "ef_Kenmerken.IdentificatieVerwarmingstoestel.Text": "",
    "ef_Kenmerken.TypeB.Open.Bool": false,
    "ef_Kenmerken.TypeC.Gesloten.Bool": false,
    "ef_KenmerkenGas.Aardgas.Bool": false,
    "ef_KenmerkenGas.AardgasG20.Bool": false,
    "ef_KenmerkenGas.AardgasG25.Bool": false,
    "ef_KenmerkenGas.Andere.Bool": false,
    "ef_KenmerkenGas.Andere.Text": "",
    "ef_KenmerkenGas.Biogas.Bool": false,
    "ef_KenmerkenGas.Butaan.Bool": false,
    "ef_KenmerkenGas.Gasketel.Unit.Bool": false,
    "ef_KenmerkenGas.Gasketel.VentilatorBrander.GII.Bool": false,
    "ef_KenmerkenGas.Gasvormige.Brandstof.Bool": false,
    "ef_KenmerkenGas.Label.Energielabel.Bool": false,
    "ef_KenmerkenGas.Label.Energielabel.Text": "",
    "ef_KenmerkenGas.Label.Geen.Bool": false,
    "ef_KenmerkenGas.Label.HR.Bool": false,
    "ef_KenmerkenGas.Label.HRPlus.Bool": false,
    "ef_KenmerkenGas.Label.HRTop.Bool": false,
    "ef_KenmerkenGas.Label.Wit.Bool": false,
    "ef_KenmerkenGas.LPG.Bool": false,
    "ef_KenmerkenGas.NietPremix.GI.Bool": false,
    "ef_KenmerkenGas.Premix.GI.Bool": false,
    "ef_KenmerkenGas.Propaan.Bool": false,
    "ef_KenmerkenVast.Andere.Bool": false,
    "ef_KenmerkenVast.Andere.Text": "",
    "ef_KenmerkenVast.Granen.Bool": false,
    "ef_KenmerkenVast.Houtblokken.Bool": false,
    "ef_KenmerkenVast.Houtpellets.Bool": false,
    "ef_KenmerkenVast.Label.Energielabel.Bool": false,
    "ef_KenmerkenVast.Label.Energielabel.Text": "",
    "ef_KenmerkenVast.Label.Geen.Bool": false,
    "ef_KenmerkenVast.Spaanders.Bool": false,
    "ef_KenmerkenVast.Steenkool.Bool": false,
    "ef_KenmerkenVast.VasteBrandstof.Bool": false,
    "ef_KenmerkenVloeibaar.Andere.Bool": false,
    "ef_KenmerkenVloeibaar.Gasolie.Bool": false,
    "ef_KenmerkenVloeibaar.GasolieExtra.Bool": false,
    "ef_KenmerkenVloeibaar.Label.Energielabel.Bool": false,
    "ef_KenmerkenVloeibaar.Label.Energielabel.Text": "",
    "ef_KenmerkenVloeibaar.Label.Geen.Bool": false,
    "ef_KenmerkenVloeibaar.Label.Optimaz.Bool": false,
    "ef_KenmerkenVloeibaar.Label.OptimazElite.Bool": false,
    "ef_KenmerkenVloeibaar.VloeibareBrandstof.Bool": false,
    "ef_KenmerkenVloeibaar.VloeibareBrandstof.Type.Text": "",
    "ef_KenmerkenVloeibaar.ZwareStookolie.Bool": false,
    "ef_Toestel.AlsGasOpenKetelJa.Bool": false,
    "ef_Toestel.AlsGasOpenKetelNee.Bool": false,
    "ef_Toestel.AlsMazoutLuchtOfRookklepJa.Bool": false,
    "ef_Toestel.AlsMazoutLuchtOfRookklepNee.Bool": false,
    "ef_Toestel.Bouwjaar.Int": 0,
    "ef_Toestel.CondensatieJa.Bool": false,
    "ef_Toestel.CondensatieNee.Bool": false,
    "ef_Toestel.Fabricatienr.Text": "",
    "ef_Toestel.KenplaatAanwezig.Bool": false,
    "ef_Toestel.KenplaatAfwezig.Bool": false,
    "ef_Toestel.Label.Text": "",
    "ef_Toestel.Merk.Text": "",
    "ef_Toestel.Type.Text": "",
    "ef_Toestel.Vermogen.Double": 0
  }
]
}