Server

<back to all web services

GetNutzeinheit

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

// @DataContract
export class Address
{
    // @DataMember
    public guid: string;

    // @DataMember
    public street: string;

    // @DataMember
    public street2: string;

    // @DataMember
    public streetNumber: string;

    // @DataMember
    public zipcode: string;

    // @DataMember
    public city: string;

    // @DataMember
    public mailbox: string;

    // @DataMember
    public additional: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export enum NutzerType
{
    Leerstand = 'Leerstand',
    Gewerblich = 'Gewerblich',
    Privat = 'Privat',
    AllgemeineNutzung = 'AllgemeineNutzung',
}

// @DataContract
export class Nutzer
{
    // @DataMember
    public guid: string;

    // @DataMember
    public name1: string;

    // @DataMember
    public name2: string;

    // @DataMember
    public name3: string;

    // @DataMember
    public name4: string;

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

    // @DataMember
    public nutzeinheitNumberExternal: string;

    // @DataMember
    // @ApiMember(IsRequired=true)
    public nutzerInNutzeinheitSequence: number;

    // @DataMember
    // @ApiMember(IsRequired=true)
    public rangeFrom: string;

    // @DataMember
    public rangeTo?: string;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember(Name="IstUvi")
    public IstUvi: string;

    // @DataMember(Name="EigentuemerBewohnt")
    public EigentuemerBewohnt: string;

    // @DataMember(Name="Email")
    public Email: string;

    // @DataMember(Name="Mobil")
    public Mobil: string;

    // @DataMember
    public title: string;

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

    public constructor(init?: Partial<Nutzer>) { (Object as any).assign(this, init); }
}

// @DataContract
export class OwnerNutzeinheit
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Name1")
    public Name1: string;

    // @DataMember(Name="Name2")
    public Name2: string;

    // @DataMember(Name="Name3")
    public Name3: string;

    // @DataMember(Name="Name4")
    public Name4: string;

    // @DataMember(Name="ZeitraumVon")
    public ZeitraumVon: string;

    // @DataMember(Name="ZeitraumBis")
    public ZeitraumBis?: string;

    // @DataMember(Name="Titel")
    public Titel: string;

    // @DataMember(Name="Anrede")
    public Anrede: string;

    // @DataMember(Name="AdressGuid")
    public AdressGuid: string;

    // @DataMember(Name="NutzeinheitGuid")
    public NutzeinheitGuid: string;

    public constructor(init?: Partial<OwnerNutzeinheit>) { (Object as any).assign(this, init); }
}

// @DataContract
export class NutzeinheitDevice
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="ZuordnungVon")
    public ZuordnungVon: string;

    // @DataMember(Name="ZuordnungBis")
    public ZuordnungBis?: string;

    // @DataMember(Name="Raum")
    public Raum: string;

    // @DataMember(Name="LaufendeNummer")
    public LaufendeNummer: string;

    // @DataMember(Name="gemietet")
    public gemietet: boolean;

    // @DataMember(Name="gewartet")
    public gewartet: boolean;

    // @DataMember(Name="DeviceGuid")
    public DeviceGuid: string;

    // @DataMember(Name="NutzeinheitGuid")
    public NutzeinheitGuid: string;

    public constructor(init?: Partial<NutzeinheitDevice>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Nutzeinheit
{
    // @DataMember
    public guid: string;

    // @DataMember
    public number: string;

    // @DataMember
    public location: string;

    // @DataMember
    public address: Address;

    // @DataMember
    public nutzer: Nutzer[];

    // @DataMember
    public ownerNutzeinheiten: OwnerNutzeinheit[];

    // @DataMember
    public nutzeinheitenDevices: NutzeinheitDevice[];

    public constructor(init?: Partial<Nutzeinheit>) { (Object as any).assign(this, init); }
}

export class GetNutzeinheitResponse
{
    public nutzeinheit: Nutzeinheit;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetNutzeinheitResponse>) { (Object as any).assign(this, init); }
}

export class GetNutzeinheit implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public guid: string;

    // @ApiMember(ParameterType="query")
    public include: string;

    public constructor(init?: Partial<GetNutzeinheit>) { (Object as any).assign(this, init); }
}

TypeScript 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: depolt-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
		}
	}
}