| GET | /api/v1/objekte/{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;
}
export class Nutzeinheit {
/** @param {{Guid?:string,Nummer?:string,Lage?:string,ObjektGuid?:string,AdressGuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Guid;
/** @type {string} */
Nummer;
/** @type {string} */
Lage;
/** @type {string} */
ObjektGuid;
/** @type {string} */
AdressGuid;
}
export class BillingInformation {
/** @param {{Guid?:string,Von?:string,Bis?:string,IstAbgeschlossen?:boolean,HatNebenkosten?:boolean,ObjektGuid?:string,AnmerkungKundenportal?:string,KundenportalMarkedDone?:boolean,MarkedDoneAt?:string,KundenportalMarkedClosed?:boolean,MarkedClosedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Guid;
/** @type {string} */
Von;
/** @type {string} */
Bis;
/** @type {boolean} */
IstAbgeschlossen;
/** @type {boolean} */
HatNebenkosten;
/** @type {string} */
ObjektGuid;
/** @type {string} */
AnmerkungKundenportal;
/** @type {boolean} */
KundenportalMarkedDone;
/** @type {?string} */
MarkedDoneAt;
/** @type {boolean} */
KundenportalMarkedClosed;
/** @type {?string} */
MarkedClosedAt;
}
export class Objekt {
/** @param {{guid?:string,number?:string,isCompleted?:string,completedDate?:string,address?:Address,nutzeinheiten?:Nutzeinheit[],billingInformations?:BillingInformation[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
guid;
/** @type {string} */
number;
/** @type {string} */
isCompleted;
/** @type {?string} */
completedDate;
/** @type {Address} */
address;
/** @type {Nutzeinheit[]} */
nutzeinheiten;
/** @type {BillingInformation[]} */
billingInformations;
}
export class GetObjektResponse {
/** @param {{objekt?:Objekt,responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Objekt} */
objekt;
/** @type {ResponseStatus} */
responseStatus;
}
export class GetObjekt {
/** @param {{bearerToken?:string,guid?:string,include?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
bearerToken;
/** @type {string} */
guid;
/** @type {string} */
include;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/v1/objekte/{Guid} HTTP/1.1
Host: mitchell-servdesk.eras-online.de
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
objekt:
{
guid: 00000000000000000000000000000000,
number: String,
isCompleted: String,
completedDate: 0001-01-01T00:00:00Z,
address:
{
guid: 00000000000000000000000000000000,
street: String,
street2: String,
streetNumber: String,
zipcode: String,
city: String,
mailbox: String,
additional: String
},
nutzeinheiten:
[
{
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:00Z,
rangeTo: 0001-01-01T00:00:00Z,
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:00Z,
rangeTo: 0001-01-01T00:00:00Z,
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:00Z,
assignedToDate: 0001-01-01T00:00:00Z,
room: String,
ongoingNumber: String,
isRented: False,
isMaintained: False,
device:
{
guid: 00000000000000000000000000000000,
number: String,
label: String,
description: String,
installationDate: 0001-01-01T00:00:00Z,
deinstallationDate: 0001-01-01T00:00:00Z,
calibrationDate: 0001-01-01T00:00:00Z,
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:00Z,
deviceReadingKind: ZA,
changeDate: 0001-01-01T00:00:00Z,
note: String,
ampouleColour: String,
deviceGuid: String
}
]
}
}
]
}
],
billingInformations:
[
{
guid: String,
from: 0001-01-01T00:00:00Z,
to: 0001-01-01T00:00:00Z,
isCompleted: False,
hasNebenkosten: False
}
]
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}