| GET | /api/v1/objekte/{Guid} |
|---|
import Foundation
import ServiceStack
public class GetObjekt : IHasBearerToken, Codable
{
// @ApiMember(IsRequired=true, ParameterType="query")
public var bearerToken:String
// @ApiMember(IsRequired=true, ParameterType="path")
public var guid:String
// @ApiMember(ParameterType="query")
public var include:String
required public init(){}
}
public class GetObjektResponse : Codable
{
public var objekt:Objekt
public var responseStatus:ResponseStatus
required public init(){}
}
// @DataContract
public class Objekt : Codable
{
// @DataMember
public var guid:String
// @DataMember
public var number:String
// @DataMember
public var isCompleted:String
// @DataMember
public var completedDate:Date?
// @DataMember
public var address:Address
// @DataMember
public var nutzeinheiten:[Nutzeinheit] = []
// @DataMember
public var billingInformations:[BillingInformation] = []
required public init(){}
}
// @DataContract
public class Address : Codable
{
// @DataMember
public var guid:String
// @DataMember
public var street:String
// @DataMember
public var street2:String
// @DataMember
public var streetNumber:String
// @DataMember
public var zipcode:String
// @DataMember
public var city:String
// @DataMember
public var mailbox:String
// @DataMember
public var additional:String
required public init(){}
}
// @DataContract
public class Nutzeinheit : Codable
{
// @DataMember(Name="Guid")
public var Guid:String
// @DataMember(Name="Nummer")
public var Nummer:String
// @DataMember(Name="Lage")
public var Lage:String
// @DataMember(Name="ObjektGuid")
public var ObjektGuid:String
// @DataMember(Name="AdressGuid")
public var AdressGuid:String
required public init(){}
}
// @DataContract
public class BillingInformation : Codable
{
// @DataMember(Name="Guid")
public var Guid:String
// @DataMember(Name="Von")
public var Von:Date
// @DataMember(Name="Bis")
public var Bis:Date
// @DataMember(Name="IstAbgeschlossen")
public var IstAbgeschlossen:Bool
// @DataMember(Name="HatNebenkosten")
public var HatNebenkosten:Bool
// @DataMember(Name="ObjektGuid")
public var ObjektGuid:String
// @DataMember(Name="AnmerkungKundenportal")
public var AnmerkungKundenportal:String
// @DataMember(Name="KundenportalMarkedDone")
public var KundenportalMarkedDone:Bool
// @DataMember(Name="MarkedDoneAt")
public var MarkedDoneAt:Date?
// @DataMember(Name="KundenportalMarkedClosed")
public var KundenportalMarkedClosed:Bool
// @DataMember(Name="MarkedClosedAt")
public var MarkedClosedAt:Date?
required public init(){}
}
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: marneth-messdienst-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
}
}
}