Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{Guid}
"use strict";
export class Address {
    /** @param {{guid?:string,street?:string,street2?:string,streetNumber?:string,zipcode?:string,city?:string,mailbox?:string,additional?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    street;
    /** @type {string} */
    street2;
    /** @type {string} */
    streetNumber;
    /** @type {string} */
    zipcode;
    /** @type {string} */
    city;
    /** @type {string} */
    mailbox;
    /** @type {string} */
    additional;
}
/** @typedef {'Leerstand'|'Gewerblich'|'Privat'|'AllgemeineNutzung'} */
export var NutzerType;
(function (NutzerType) {
    NutzerType["Leerstand"] = "Leerstand"
    NutzerType["Gewerblich"] = "Gewerblich"
    NutzerType["Privat"] = "Privat"
    NutzerType["AllgemeineNutzung"] = "AllgemeineNutzung"
})(NutzerType || (NutzerType = {}));
export class Nutzer {
    /** @param {{guid?:string,name1?:string,name2?:string,name3?:string,name4?:string,nutzerType?:NutzerType,nutzeinheitNumberExternal?:string,nutzerInNutzeinheitSequence?:number,rangeFrom?:string,rangeTo?:string,isDeleted?:boolean,isCreatedByApp?:boolean,IstUvi?:string,EigentuemerBewohnt?:string,Email?:string,Mobil?:string,title?:string,salutation?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    name1;
    /** @type {string} */
    name2;
    /** @type {string} */
    name3;
    /** @type {string} */
    name4;
    /** @type {NutzerType} */
    nutzerType;
    /** @type {string} */
    nutzeinheitNumberExternal;
    /** @type {number} */
    nutzerInNutzeinheitSequence;
    /** @type {string} */
    rangeFrom;
    /** @type {?string} */
    rangeTo;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    IstUvi;
    /** @type {string} */
    EigentuemerBewohnt;
    /** @type {string} */
    Email;
    /** @type {string} */
    Mobil;
    /** @type {string} */
    title;
    /** @type {string} */
    salutation;
}
export class OwnerNutzeinheit {
    /** @param {{Guid?:string,Name1?:string,Name2?:string,Name3?:string,Name4?:string,ZeitraumVon?:string,ZeitraumBis?:string,Titel?:string,Anrede?:string,AdressGuid?:string,NutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Name1;
    /** @type {string} */
    Name2;
    /** @type {string} */
    Name3;
    /** @type {string} */
    Name4;
    /** @type {string} */
    ZeitraumVon;
    /** @type {?string} */
    ZeitraumBis;
    /** @type {string} */
    Titel;
    /** @type {string} */
    Anrede;
    /** @type {string} */
    AdressGuid;
    /** @type {string} */
    NutzeinheitGuid;
}
export class NutzeinheitDevice {
    /** @param {{Guid?:string,ZuordnungVon?:string,ZuordnungBis?:string,Raum?:string,LaufendeNummer?:string,gemietet?:boolean,gewartet?:boolean,DeviceGuid?:string,NutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    ZuordnungVon;
    /** @type {?string} */
    ZuordnungBis;
    /** @type {string} */
    Raum;
    /** @type {string} */
    LaufendeNummer;
    /** @type {boolean} */
    gemietet;
    /** @type {boolean} */
    gewartet;
    /** @type {string} */
    DeviceGuid;
    /** @type {string} */
    NutzeinheitGuid;
}
export class Nutzeinheit {
    /** @param {{guid?:string,number?:string,location?:string,address?:Address,nutzer?:Nutzer[],ownerNutzeinheiten?:OwnerNutzeinheit[],nutzeinheitenDevices?:NutzeinheitDevice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    number;
    /** @type {string} */
    location;
    /** @type {Address} */
    address;
    /** @type {Nutzer[]} */
    nutzer;
    /** @type {OwnerNutzeinheit[]} */
    ownerNutzeinheiten;
    /** @type {NutzeinheitDevice[]} */
    nutzeinheitenDevices;
}
export class GetNutzeinheitResponse {
    /** @param {{nutzeinheit?:Nutzeinheit,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Nutzeinheit} */
    nutzeinheit;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetNutzeinheit {
    /** @param {{bearerToken?:string,guid?:string,include?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /** @type {string} */
    guid;
    /** @type {string} */
    include;
}

JavaScript GetNutzeinheit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/nutzeinheiten/{Guid} HTTP/1.1 
Host: immo-account-servdesk.eras-online.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"nutzeinheit":{"guid":"00000000000000000000000000000000","number":"String","location":"String","address":{"guid":"00000000000000000000000000000000","street":"String","street2":"String","streetNumber":"String","zipcode":"String","city":"String","mailbox":"String","additional":"String"},"nutzer":[{"guid":"00000000000000000000000000000000","name1":"String","name2":"String","name3":"String","name4":"String","nutzerType":"Leerstand","nutzeinheitNumberExternal":"String","nutzerInNutzeinheitSequence":0,"rangeFrom":"0001-01-01T00:00:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","isDeleted":false,"isCreatedByApp":false,"IstUvi":"String","EigentuemerBewohnt":"String","Email":"String","Mobil":"String","title":"String","salutation":"String"}],"ownerNutzeinheiten":[{"guid":"00000000000000000000000000000000","name1":"String","name2":"String","name3":"String","name4":"String","rangeFrom":"0001-01-01T00:00:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","title":"String","salutation":"String","address":{"guid":"00000000000000000000000000000000","street":"String","street2":"String","streetNumber":"String","zipcode":"String","city":"String","mailbox":"String","additional":"String"}}],"nutzeinheitenDevices":[{"guid":"00000000000000000000000000000000","assignedFromDate":"0001-01-01T00:00:00.0000000Z","assignedToDate":"0001-01-01T00:00:00.0000000Z","room":"String","ongoingNumber":"String","isRented":false,"isMaintained":false,"device":{"guid":"00000000000000000000000000000000","number":"String","label":"String","description":"String","installationDate":"0001-01-01T00:00:00.0000000Z","deinstallationDate":"0001-01-01T00:00:00.0000000Z","calibrationDate":"0001-01-01T00:00:00.0000000Z","unit":"L","note":"String","deviceCatalog":{"Guid":"String","TypKurz":"String","TypLang":"String","Ablesbar":false,"Klasse":"String","Abzug":false,"Hkvv":false,"Funk":false},"deviceConsumptions":[{"guid":"00000000000000000000000000000000","deviceReading":0,"deviceReadingDate":"0001-01-01T00:00:00.0000000Z","deviceReadingKind":"ZA","changeDate":"0001-01-01T00:00:00.0000000Z","note":"String","ampouleColour":"String","deviceGuid":"String"}]}}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}