Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{Guid}
import Foundation
import ServiceStack

public class GetNutzeinheit : 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 GetNutzeinheitResponse : Codable
{
    public var nutzeinheit:Nutzeinheit
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Nutzeinheit : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var number:String

    // @DataMember
    public var location:String

    // @DataMember
    public var address:Address

    // @DataMember
    public var nutzer:[Nutzer] = []

    // @DataMember
    public var ownerNutzeinheiten:[OwnerNutzeinheit] = []

    // @DataMember
    public var nutzeinheitenDevices:[NutzeinheitDevice] = []

    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 Nutzer : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var name1:String

    // @DataMember
    public var name2:String

    // @DataMember
    public var name3:String

    // @DataMember
    public var name4:String

    // @DataMember
    // @ApiMember(IsRequired=true)
    public var nutzerType:NutzerType?

    // @DataMember
    public var nutzeinheitNumberExternal:String

    // @DataMember
    // @ApiMember(IsRequired=true)
    public var nutzerInNutzeinheitSequence:UInt32

    // @DataMember
    // @ApiMember(IsRequired=true)
    public var rangeFrom:Date

    // @DataMember
    public var rangeTo:Date?

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember(Name="IstUvi")
    public var IstUvi:String

    // @DataMember(Name="EigentuemerBewohnt")
    public var EigentuemerBewohnt:String

    // @DataMember(Name="Email")
    public var Email:String

    // @DataMember(Name="Mobil")
    public var Mobil:String

    // @DataMember
    public var title:String

    // @DataMember
    // @ApiMember(IsRequired=true, ParameterType="body")
    public var salutation:String

    required public init(){}
}

public enum NutzerType : String, Codable
{
    case Leerstand
    case Gewerblich
    case Privat
    case AllgemeineNutzung
}

// @DataContract
public class OwnerNutzeinheit : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="Name1")
    public var Name1:String

    // @DataMember(Name="Name2")
    public var Name2:String

    // @DataMember(Name="Name3")
    public var Name3:String

    // @DataMember(Name="Name4")
    public var Name4:String

    // @DataMember(Name="ZeitraumVon")
    public var ZeitraumVon:Date

    // @DataMember(Name="ZeitraumBis")
    public var ZeitraumBis:Date?

    // @DataMember(Name="Titel")
    public var Titel:String

    // @DataMember(Name="Anrede")
    public var Anrede:String

    // @DataMember(Name="AdressGuid")
    public var AdressGuid:String

    // @DataMember(Name="NutzeinheitGuid")
    public var NutzeinheitGuid:String

    required public init(){}
}

// @DataContract
public class NutzeinheitDevice : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="ZuordnungVon")
    public var ZuordnungVon:Date

    // @DataMember(Name="ZuordnungBis")
    public var ZuordnungBis:Date?

    // @DataMember(Name="Raum")
    public var Raum:String

    // @DataMember(Name="LaufendeNummer")
    public var LaufendeNummer:String

    // @DataMember(Name="gemietet")
    public var gemietet:Bool

    // @DataMember(Name="gewartet")
    public var gewartet:Bool

    // @DataMember(Name="DeviceGuid")
    public var DeviceGuid:String

    // @DataMember(Name="NutzeinheitGuid")
    public var NutzeinheitGuid:String

    required public init(){}
}

Swift GetNutzeinheit DTOs

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

HTTP + JSV

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: mi-waerme-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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: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
						}
					]
				}
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}