Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{Guid}
GetNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
BearerTokenquerystringYes
GuidpathGuidYes
IncludequerystringNo

Allowable Values

  • devices
  • consumptions
GetNutzeinheitResponse Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitformNutzeinheitNo
ResponseStatusformResponseStatusNo
Nutzeinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NumberformstringNo
LocationformstringNo
AddressformAddressNo
NutzerformList<Nutzer>No
OwnerNutzeinheitenformList<OwnerNutzeinheit>No
NutzeinheitenDevicesformList<NutzeinheitDevice>No
Address Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
StreetformstringNo
Street2formstringNo
StreetNumberformstringNo
ZipcodeformstringNo
CityformstringNo
MailboxformstringNo
AdditionalformstringNo
Nutzer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
Name4formstringNo
NutzerTypeformNutzerType?Yes

Allowable Values

  • Leerstand
  • Gewerblich
  • Privat
  • AllgemeineNutzung
NutzeinheitNumberExternalformstringNo
NutzerInNutzeinheitSequenceformuintYes
RangeFromformDateTimeYes
RangeToformDateTime?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
IsUviRecievedformstringNo
IsNutzerOwnerformstringNo
EmailformstringNo
MobilePhoneformstringNo
TitleformstringNo
SalutationbodystringYes
NutzerType Enum:
Leerstand
Gewerblich
Privat
AllgemeineNutzung
OwnerNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
Name4formstringNo
RangeFromformDateTimeNo
RangeToformDateTime?No
TitleformstringNo
SalutationformstringNo
AddressGuidformstringNo
NutzeinheitGuidformstringNo
NutzeinheitDevice Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
AssignedFromDateformDateTimeNo
AssignedToDateformDateTime?No
RoomformstringNo
OngoingNumberformstringNo
IsRentedformboolNo
IsMaintainedformboolNo
DeviceGuidformstringNo
NutzeinheitGuidformstringNo

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: heat-syke-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
		}
	}
}