Server

<back to all web services

GetCustomerOnlineStatus

Requires Authentication
The following routes are available for this service:
GET/CustomerOnlineStatus/{Guid}
GetCustomerOnlineStatus Parameters:
NameParameterData TypeRequiredDescription
GuidpathGuidNo
GetCustomerOnlineStatusResponse Parameters:
NameParameterData TypeRequiredDescription
KundeformCustomerNo
ObjekteformList<Objekt>No
BillingInformationformList<BillingInformation>No
ResponseStatusformResponseStatusNo
Customer Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
NumberformstringNo
SalutationformstringNo
CustomerAddressesformList<CustomerAddress>No
CustomerObjekteformList<CustomerObjekt>No
CustomerAddress Parameters:
NameParameterData TypeRequiredDescription
AddressGuidformstringNo
IsPrimaryformboolNo
AddressKindLabelformstringNo
AddressKindTypformstringNo
CustomerObjekt Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
RangeFromformDateTimeNo
RangeToformDateTime?No
IsCustomerformboolNo
IsOwnerformboolNo
IsOwnerPseudoformboolNo
ObjektGuidformstringNo
CustomerGuidformstringNo
Objekt Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
NumberformstringNo
IsCompletedformstringNo
UviformstringNo
IsUviDisabledformstringNo
CompletedDateformDateTime?No
AddressGuidformstringNo
AnmerkungKundenportalformstringNo
KundenportalMarkedDoneformboolNo
MarkedDoneAtformDateTime?No
BillingInformation Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
IsCompletedformboolNo
HasNebenkostenformboolNo
ObjektGuidformstringNo
AnmerkungKundenportalformstringNo
KundenportalMarkedDoneformboolNo
MarkedDoneAtformDateTime?No
KundenportalMarkedClosedformboolNo
MarkedClosedAtformDateTime?No

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 /CustomerOnlineStatus/{Guid} HTTP/1.1 
Host: fairtherm-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	kunde: 
	{
		Guid: String,
		Name1: String,
		Name2: String,
		Name3: String,
		Kundennummer: String,
		Anrede: String,
		KundenAdressen: 
		[
			{
				AdresseGuid: String,
				IstPrimaer: False,
				AdressTypBezeichnung: String,
				AdressTyp: String
			}
		],
		KundenObjekte: 
		[
			{
				Guid: String,
				ZeitraumVon: 0001-01-01T00:00:00Z,
				ZeitraumBis: 0001-01-01T00:00:00Z,
				IstKunde: False,
				IstEigentümer: False,
				IstEigentümerPseudo: False,
				ObjektGuid: String,
				KundeGuid: String
			}
		]
	},
	objekte: 
	[
		{
			Guid: String,
			Objektnummer: String,
			IstAbgeschlossen: String,
			Uvi: String,
			IsUviDisabled: String,
			AbgeschlossenDatum: 0001-01-01T00:00:00Z,
			AdressGuid: String,
			AnmerkungKundenportal: String,
			KundenportalMarkedDone: False,
			MarkedDoneAt: 0001-01-01T00:00:00Z
		}
	],
	billingInformation: 
	[
		{
			Guid: String,
			Von: 0001-01-01T00:00:00Z,
			Bis: 0001-01-01T00:00:00Z,
			IstAbgeschlossen: False,
			HatNebenkosten: False,
			ObjektGuid: String,
			AnmerkungKundenportal: String,
			KundenportalMarkedDone: False,
			MarkedDoneAt: 0001-01-01T00:00:00Z,
			KundenportalMarkedClosed: False,
			MarkedClosedAt: 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
		}
	}
}