Server

<back to all web services

GetCustomersOnlineStatus

Requires Authentication
The following routes are available for this service:
GET/CustomersOnlineStatus
"use strict";
export class CustomerAddress {
    /** @param {{AdresseGuid?:string,IstPrimaer?:boolean,AdressTypBezeichnung?:string,AdressTyp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AdresseGuid;
    /** @type {boolean} */
    IstPrimaer;
    /** @type {string} */
    AdressTypBezeichnung;
    /** @type {string} */
    AdressTyp;
}
export class CustomerObjekt {
    /** @param {{Guid?:string,ZeitraumVon?:string,ZeitraumBis?:string,IstKunde?:boolean,IstEigent_mer?:boolean,IstEigent_merPseudo?:boolean,ObjektGuid?:string,KundeGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    ZeitraumVon;
    /** @type {?string} */
    ZeitraumBis;
    /** @type {boolean} */
    IstKunde;
    /** @type {boolean} */
    IstEigent_mer;
    /** @type {boolean} */
    IstEigent_merPseudo;
    /** @type {string} */
    ObjektGuid;
    /** @type {string} */
    KundeGuid;
}
export class Customer {
    /** @param {{Guid?:string,Name1?:string,Name2?:string,Name3?:string,Kundennummer?:string,Anrede?:string,KundenAdressen?:CustomerAddress[],KundenObjekte?:CustomerObjekt[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Name1;
    /** @type {string} */
    Name2;
    /** @type {string} */
    Name3;
    /** @type {string} */
    Kundennummer;
    /** @type {string} */
    Anrede;
    /** @type {CustomerAddress[]} */
    KundenAdressen;
    /** @type {CustomerObjekt[]} */
    KundenObjekte;
}
export class Objekt {
    /** @param {{Guid?:string,Objektnummer?:string,IstAbgeschlossen?:string,Uvi?:string,IsUviDisabled?:string,AbgeschlossenDatum?:string,AdressGuid?:string,AnmerkungKundenportal?:string,KundenportalMarkedDone?:boolean,MarkedDoneAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Objektnummer;
    /** @type {string} */
    IstAbgeschlossen;
    /** @type {string} */
    Uvi;
    /** @type {string} */
    IsUviDisabled;
    /** @type {?string} */
    AbgeschlossenDatum;
    /** @type {string} */
    AdressGuid;
    /** @type {string} */
    AnmerkungKundenportal;
    /** @type {boolean} */
    KundenportalMarkedDone;
    /** @type {?string} */
    MarkedDoneAt;
}
export class BillingInformation {
    /** @param {{Guid?:string,Von?:string,Bis?:string,IstAbgeschlossen?:boolean,HatNebenkosten?:boolean,ObjektGuid?:string,AnmerkungKundenportal?:string,KundenportalMarkedDone?:boolean,MarkedDoneAt?:string,KundenportalMarkedClosed?:boolean,MarkedClosedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Von;
    /** @type {string} */
    Bis;
    /** @type {boolean} */
    IstAbgeschlossen;
    /** @type {boolean} */
    HatNebenkosten;
    /** @type {string} */
    ObjektGuid;
    /** @type {string} */
    AnmerkungKundenportal;
    /** @type {boolean} */
    KundenportalMarkedDone;
    /** @type {?string} */
    MarkedDoneAt;
    /** @type {boolean} */
    KundenportalMarkedClosed;
    /** @type {?string} */
    MarkedClosedAt;
}
export class GetCustomersOnlineStatusResponse {
    /** @param {{kunden?:Customer[],objekte?:Objekt[],billingInformation?:BillingInformation[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Customer[]} */
    kunden;
    /** @type {Objekt[]} */
    objekte;
    /** @type {BillingInformation[]} */
    billingInformation;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetCustomersOnlineStatus {
    /** @param {{KundenGuids?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    KundenGuids;
}

JavaScript GetCustomersOnlineStatus 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 /CustomersOnlineStatus HTTP/1.1 
Host: isp-plauen-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	kunden: 
	[
		{
			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
		}
	}
}