Server

<back to all web services

GetNotes

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Status/Notes
Eras2AppServiceModelBase Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
GetNotesResponse Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitenformList<Nutzeinheit>No
OrdersformList<Order>No
AbrechnungseinheitenformList<Abrechnungseinheit>No
ResponseStatusformResponseStatusNo
Nutzeinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NumberformstringNo
LocationformstringNo
WalkSequenceformstringNo
NoteformstringNo
AbrechnungseinheitGuidformGuidNo
AddressformAddressNo
DevicesformIList<Device>No
NutzerformIList<Nutzer>No
PhotosformIList<Photo>No
Address Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
StreetformstringNo
Street2formstringNo
StreetNumberformstringNo
ZipcodeformstringNo
CityformstringNo
MailboxformstringNo
AdditionalformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
Device Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NumberformstringNo
LabelformstringNo
DescriptionformstringNo
InstallationDateformDateTimeNo
DeinstallationDateformDateTime?No
CalibrationDateformDateTime?No
UnitformUnitKind?No
NoteformstringNo
SubtractionformboolNo
GroupIdentifierformstringNo
EstimationformEstimationKind?No
FirstActivationformDateTime?No
FirmwareVersionformstringNo
RoomGuidformGuidNo
OngoingNumberformstringNo
IsLeasedformboolNo
IsMaintainedformboolNo
DeviceCatalogGuidformGuidNo
DeviceConsumptionsformIList<DeviceConsumption>No
PhotosformIList<Photo>No
DeviceAdditionalArticlesformIList<DeviceAdditionalArticle>No
UnitKind Enum:
L
Kg
CBM
Stck
KWH
MWH
GWH
T
RM
Einheit
Qm
GJ
MJ
Null
EstimationKind Enum:
Null
S1
S2
S3
S4
S5
N1
N2
DeviceConsumption Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
ReadingDateformDateTime?No
FactorformdoubleNo
Readingformdouble?No
Consumptionformdouble?No
ChangeDateformDateTime?No
EstimationformEstimationKind?No
StateformDeviceConsumptionState?No
NoteformstringNo
IsReconstructedformboolNo
Manualformdouble?No
OriginformDeviceConsumptionOrigin?No
AirTemperatureformdecimal?No
RadiatorTemperatureformdecimal?No
LastErrorDateformDateTime?No
ErrorformstringNo
AmpouleColourformstringNo
ReadindKindGuidformGuidNo
DeviceConsumptionState Enum:
Null
RMInOrdnung
RMFehler
RMNichtGepr
RMFehlerTausch
KeinWohnungszutritt
Defekt
FalschLaufend
Überlauf
EichungBeachten
ProbeEntnommen
ProbeZumLabor
ProbePositiv
ProbeNegativ
DeviceConsumptionOrigin Enum:
Unbekannt
Manual
Emr
Walkby
Deleted
Photo Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
RecordedDateformDateTimeNo
DeviceAdditionalArticle Parameters:
NameParameterData TypeRequiredDescription
AdditionalArticleGuidformGuidNo
Quantityformdecimal?No
LastModifiedformDateTime?No
Nutzer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
KindformNutzerKind?No
MoveInDateformDateTime?No
MoveOutDateformDateTime?No
Name1formstringNo
Name2formstringNo
Name3formstringNo
Name4formstringNo
NoteformstringNo
NextAppointmentDateformDateTime?No
SalutationformstringNo
TitleformstringNo
NutzerCommunicationsformIEnumerable<NutzerCommunication>No
NutzerPersonenformIEnumerable<NutzerPersonen>No
NutzerCoOwnershipformIEnumerable<NutzerCoOwnership>No
NutzerQuadratmeterformIEnumerable<NutzerQuadratmeter>No
NutzerKind Enum:
Leerstand
Gewerblich
Privat
AllgemeineNutzung
NutzerCommunication Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
AddressformstringNo
NoteformstringNo
CommunicationFeatureGuidformGuidNo
NutzerPersonen Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NumberOfPeopleformint?No
RangeFromformDateTimeNo
RangeToformDateTime?No
NutzerCoOwnership Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
ShareValueformdecimal?No
RangeFromformDateTimeNo
RangeToformDateTime?No
NutzerQuadratmeter Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
SquareMeters_Hzgformdecimal?No
SquareMeters_Wwformdecimal?No
SquareMeters_Nkformdecimal?No
RangeFromformDateTimeNo
RangeToformDateTime?No
Order Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
AbrechnungseinheitGuidformGuidNo
NumberformstringNo
LabelformstringNo
NoteformstringNo
IsSignatureRequiredformboolNo
CreatedDateformDateTimeNo
OrderStateformOrderStateNo
AppointmentsformIList<Appointment>No
OrderPositionsformIList<OrderPosition>No
NutzeinheitOrderStatesformIList<NutzeinheitOrderState>No
DeviceOrderStatesformIList<DeviceOrderState>No
OrdererformOrdererNo
SignaturesformIList<Signature>No
OrderState Parameters:
NameParameterData TypeRequiredDescription
LastModifiedformDateTime?No
KindsformIList<Nullable<OrderKind>>No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
ProcessState Enum:
InProgress
Updating
Creating
Completed
Appointment Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
FromformDateTimeNo
ToformDateTimeNo
AppointmentStoreUsersformIList<AppointmentStoreUser>No
AppointmentNutzeinheitenformIList<AppointmentNutzeinheit>No
AppointmentStoreUser Parameters:
NameParameterData TypeRequiredDescription
StoreUserIdformGuidNo
AppointmentNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
OrderPosition Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NoteformstringNo
RequiredQuantityformintNo
ActualQuantityformintNo
NutzeinheitOrderPositionsformIList<NutzeinheitOrderPosition>No
ArticleGuidformGuidNo
NutzeinheitOrderPosition Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
NutzeinheitOrderState Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
LastModifiedformDateTime?No
OrderKindsformIList<Nullable<NutzeinheitOrderKind>>No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
OsVersionformstringNo
AppVersionformstringNo
OsPlatformformstringNo
AppDeviceNumberformstringNo
AmwInfoKeyGuidformGuid?No
DeviceOrderState Parameters:
NameParameterData TypeRequiredDescription
DeviceGuidformGuidNo
OrderGuidformGuidNo
OrderKindformDeviceOrderKind?No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
AmwInfoformstringNo
DeviceOrderKind Enum:
AssemblyMontage
MaintenanceWartung
ExchangeEichaustausch
ReadingAblesung
InspectionPrüfung
MainReadingHauptablesung
Orderer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
PersonformPersonNo
BusinessPositionformstringNo
Person Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
Lastname1formstringNo
Lastname2formstringNo
Lastname3formstringNo
Firstname1formstringNo
Firstname2formstringNo
NoteformstringNo
SalutationformstringNo
TitleformstringNo
PersonCommunicationsformIEnumerable<PersonCommunication>No
PersonCommunication Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
AddressformstringNo
NoteformstringNo
CommunicationFeatureGuidformGuidNo
Signature Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
RecordedDateformDateTime?No
KindformSignatureKind?No
NutzeinheitGuidformGuidNo
SignatureKind Enum:
Nutzer
Technician
Abrechnungseinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NumberformstringNo
NoteformstringNo
NoteInternalformstringNo
NoteLegionellaformstringNo
CustomerformCustomerNo
AddressformAddressNo
BilligPeriodEndformDateTime?No
PersonAbrechnungseinheitenformIList<PersonAbrechnungseinheit>No
PersonsformIList<Person>No
Customer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NameformstringNo
Name2formstringNo
Name3formstringNo
NumberformstringNo
NoteformstringNo
SalutationformstringNo
PersonAbrechnungseinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NoteformstringNo
PersonGuidformGuidNo
BusinessPositionformstringNo

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 /App/{UserId}/Status/Notes HTTP/1.1 
Host: stage-servamw.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Nutzeinheiten: 
	[
		{
			Guid: 00000000000000000000000000000000,
			LastModified: 0001-01-01T00:00:00Z,
			NeNummerInt: String,
			Lage: String,
			BegeReihenfolge: String,
			Anmerkung: String,
			AbrechnungseinheitGuid: 00000000000000000000000000000000,
			Adresse: 
			{
				Guid: 00000000000000000000000000000000,
				Straße: String,
				Straße2: String,
				Hausnummer: String,
				Postleitzahl: String,
				Ort: String,
				Postfach: String,
				Adresszusatz: String,
				Breitengrad: 0,
				Laengengrad: 0
			}
		}
	],
	Orders: 
	[
		{
			Guid: 00000000000000000000000000000000,
			LastModified: 0001-01-01T00:00:00Z,
			AbrechnungseinheitGuid: 00000000000000000000000000000000,
			AuftragNummer: String,
			Bezeichnung: String,
			Anmerkung: String,
			UnterschriftBenoetigt: False,
			Erstellungsdatum: 0001-01-01T00:00:00Z,
			AuftragZustand: 
			{
				LastModified: 0001-01-01T00:00:00Z,
				Bearbeitungsstatus: InProgress,
				AbgeschlossenDatum: 0001-01-01T00:00:00Z
			},
			Auftraggeber: 
			{
				Guid: 00000000000000000000000000000000,
				Person: 
				{
					Guid: 00000000000000000000000000000000,
					LastModified: 0001-01-01T00:00:00Z,
					Nachname1: String,
					Nachname2: String,
					Nachname3: String,
					Vorname1: String,
					Vorname2: String,
					Anmerkung: String,
					Anrede: String,
					Titel: String
				},
				BetrieblichePosition: String
			}
		}
	],
	Abrechnungseinheiten: 
	[
		{
			Guid: 00000000000000000000000000000000,
			LastModified: 0001-01-01T00:00:00Z,
			Objektnummer: String,
			Notiz: String,
			NotizIntern: String,
			NotizLegionellen: String,
			Kunde: 
			{
				Guid: 00000000000000000000000000000000,
				Name: String,
				Name2: String,
				Name3: String,
				Kundennummer: String,
				Notiz: String,
				Anrede: String
			},
			Adresse: 
			{
				Guid: 00000000000000000000000000000000,
				Straße: String,
				Straße2: String,
				Hausnummer: String,
				Postleitzahl: String,
				Ort: String,
				Postfach: String,
				Adresszusatz: String,
				Breitengrad: 0,
				Laengengrad: 0
			},
			BillingPeriodEnd: 0001-01-01T00:00:00Z
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}